Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Mail::Message::ConstruUserTContributed Perl DMail::Message::Construct::Text(3)

NAME
       Mail::Message::Construct::Text -	capture	a Mail::Message	as text

SYNOPSIS
	my $text = $msg->string;
	my $text = "$msg";   # via overload

	my @text = $msg->lines;
	my @text = @$lines;  # via overload

	my $fh	 = $msg->file;
	my $line = <$fh>;

	$msg->printStructure;

DESCRIPTION
       Complex functionality on	Mail::Message objects is implemented in
       different files which are autoloaded.  This file	implements the
       functionality related to	creating message replies.

METHODS
   The whole message as	text
       $obj->file()
	   Returns the message as file-handle.

       $obj->lines()
	   Returns the whole message as	set of lines.  In LIST context,	copies
	   of the lines	are returned.  In SCALAR context, a reference to an
	   array of lines is returned.

       $obj->printStructure( [$fh|undef],[$indent] )
	   Print the structure of a message to the specified $fh or the
	   selected filehandle.	 When explicitly "undef" is specified as
	   handle, then	the output will	be returned as string.

	   The message's subject and the types of all composing	parts are
	   displayed.

	   $indent specifies the initial indentation string: it	is added in
	   front of each line. The $indent must	contain	at least one white-
	   space.

	   example:

	    my $msg = ...;
	    $msg->printStructure(\*OUTPUT);

	    $msg->printStructure;

	    my $struct = $msg->printStructure(undef);

	    # Possible output for one message:
	    multipart/mixed: forwarded message from Pietje Puk (1550 bytes)
	       text/plain (164 bytes)
	       message/rfc822 (1043 bytes)
		  multipart/alternative: A multipart alternative (942 bytes)
		     text/plain	(148 bytes, deleted)
		     text/html (358 bytes)

       $obj->string()
	   Returns the whole message as	string.

   Flags
SEE ALSO
       This module is part of Mail-Message distribution	version	3.011, built
       on July 27, 2021. Website: http://perl.overmeer.net/CPAN/

LICENSE
       Copyrights 2001-2021 by [Mark Overmeer <markov@cpan.org>]. For other
       contributors see	ChangeLog.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.  See http://dev.perl.org/licenses/

perl v5.32.1			  2021-07-27 Mail::Message::Construct::Text(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Mail::Message::Construct::Text&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help