NAME

overload: '==' and '!='

overload: @{}

overload: bool

See Constructors in the Mail::Message::Body manpage

METHODS

Constructors

$obj->clone

Mail::Message::Body::Multipart->new(OPTIONS)

 Option             Defined in       Default             
 based_on           L<Mail::Message::Body>  undef               
 boundary                            undef               
 charset            L<Mail::Message::Body>  C<'us-ascii'>       
 checked            L<Mail::Message::Body>  <false>             
 data               L<Mail::Message::Body>  undef               
 disposition        L<Mail::Message::Body>  undef               
 eol                L<Mail::Message::Body>  C<'NATIVE'>         
 epilogue                            undef               
 file               L<Mail::Message::Body>  undef               
 log                L<Mail::Reporter>  C<'WARNINGS'>       
 message            L<Mail::Message::Body>  undef               
 mime_type          L<Mail::Message::Body>  C<'multipart/mixed'>
 modified           L<Mail::Message::Body>  <false>             
 parts                               undef               
 preamble                            undef               
 trace              L<Mail::Reporter>  C<'WARNINGS'>       
 transfer_encoding  L<Mail::Message::Body>  C<'none'>

. based_on BODY

. boundary STRING

Separator to be used between parts of the message. This separator must be unique in case the message contains nested multiparts (which are not unusual). If undef, a nice unique boundary will be generated.

. charset STRING

. checked BOOLEAN

. data ARRAY-OF-LINES | STRING

. disposition STRING|FIELD

. eol 'CR'|'LF'|'CRLF'|'NATIVE'

. epilogue BODY|STRING

The text which is included in the main body after the final boundary. This is usually empty, and has no meaning.

Provide a BODY object or a STRING which will automatically translated into a text/plain body.

. file FILENAME|FILEHANDLE|IOHANDLE

. log LEVEL

. message MESSAGE

. mime_type STRING|FIELD|MIME

. modified BOOLEAN

. parts ARRAY-OF-(MESSAGES|BODIES)

Specifies an initial list of parts in this body. These may be full MESSAGES, or BODIES which transformed into messages before use. Each message is coerced into a Mail::Message::Part object.

MIME::Entity and Mail::Internet objects are acceptable in the list, because they are coercible into Mail::Message::Part's. Values of undef will be skipped silently.

. preamble BODY|STRING

The text which is included in the body before the first part. It is common use to include a text to warn the user that the message is a multipart. However, this was useful in earlier days: most mail agents are very capable in warning the user themselves.

Provide a BODY object or a STRING which will automatically translated into a text/plain body.

. trace LEVEL

. transfer_encoding STRING|FIELD

Example:

 my $intro = Mail::Message::Body->new(data => ['part one']);
 my $pgp   = Mail::Message::Body->new(data => ['part three']);

 my $body  = Mail::Message::Body::Multipart->new
   ( boundary => time . '--it-s-mine'
   , preamble => "This is a multi-part message in MIME format.\n\n"
   , parts    => [ $intro, $folder->message(3)->decoded, $pgp ]
   );

Constructing a body

$obj->attach(MESSAGES|BODIES)

Attach a list of MESSAGES to this multipart. A new body is returned. When you specify BODIES, they will first be translated into real messages. MIME::Entity and Mail::Internet objects may be specified too. In any case, the parts will be coerced into Mail::Message::Part's.

$obj->check

See Constructing a body in the Mail::Message::Body::Encode manpage

$obj->concatenate(COMPONENTS)

See Constructing a body in the Mail::Message::Body::Construct manpage

$obj->decoded(OPTIONS)

See Constructing a body in the Mail::Message::Body manpage

$obj->encode(OPTIONS)

See Constructing a body in the Mail::Message::Body::Encode manpage

$obj->encoded

See Constructing a body in the Mail::Message::Body::Encode manpage

$obj->eol(['CR'|'LF'|'CRLF'|'NATIVE'])

See Constructing a body in the Mail::Message::Body manpage

$obj->foreachComponent(CODE)

Execute the CODE for each component of the message: the preamble, the epilogue, and each of the parts.

Each component is a body and is passed as second argument to the CODE. The first argument is a reference to this multi-parted body. The CODE returns a body object. When any of the returned bodies differs from the body which was passed, then a new multi-part body will be returned. Reference to the not-changed bodies and the changed bodies will be included in that new multi-part.

Example:

 my $checked = $multi->foreachComponent(sub {$_[1]->check});

$obj->foreachLine(CODE)

See Constructing a body in the Mail::Message::Body::Construct manpage

$obj->stripSignature(OPTIONS)

Removes all parts which contains data usually defined as being signature. The MIME::Type module provides this knowledge. A new multipart is returned, containing the remaining parts. No OPTIONS are defined yet, although some may be specified, because this method overrules the stripSignature method for normal bodies.

 Option       Defined in       Default          
 max_lines    L<Mail::Message::Body::Construct>  C<10>            
 pattern      L<Mail::Message::Body::Construct>  C<qr/^--\s?$/>   
 result_type  L<Mail::Message::Body::Construct>  <same as current>

. max_lines INTEGER|undef

. pattern REGEX|STRING|CODE

. result_type CLASS

$obj->unify(BODY)

See Constructing a body in the Mail::Message::Body::Encode manpage

The body

$obj->isDelayed

$obj->isMultipart

$obj->isNested

$obj->message([MESSAGE])

See About the payload in the Mail::Message::Body manpage

About the payload

$obj->charset

$obj->checked([BOOLEAN])

See About the payload in the Mail::Message::Body manpage

$obj->disposition([STRING|FIELD])

See About the payload in the Mail::Message::Body manpage

$obj->dispositionFilename([DIRECTORY])

See About the payload in the Mail::Message::Body::Encode manpage

$obj->isBinary

See About the payload in the Mail::Message::Body::Encode manpage

$obj->isText

See About the payload in the Mail::Message::Body::Encode manpage

$obj->mimeType

See About the payload in the Mail::Message::Body manpage

$obj->nrLines

See About the payload in the Mail::Message::Body manpage

$obj->size

See About the payload in the Mail::Message::Body manpage

$obj->transferEncoding([STRING|FIELD])

See About the payload in the Mail::Message::Body manpage

$obj->type([STRING|FIELD])

See About the payload in the Mail::Message::Body manpage

Access to the payload

$obj->boundary([STRING])

Returns the boundary which is used to separate the parts in this body. If none was read from file, then one will be assigned. With STRING you explicitly set the boundary to be used.

$obj->epilogue

Returns the epilogue; the text after the last message part (after the last real attachment). The epilogue is stored in a BODY object, and its encoding is taken from the general multipart header.

$obj->file

See Access to the payload in the Mail::Message::Body manpage

$obj->lines

See Access to the payload in the Mail::Message::Body manpage

$obj->part(INDEX)

Returns only the part with the specified INDEX. You may use a negative value here, which counts from the back in the list. Parts which are flagged to be deleted are included in the count.

Example:

 $message->body->part(2)->print;
 $body->part(1)->delete;

$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])

Return all parts by default, or when ALL is specified. ACTIVE returns the parts which are not flagged for deletion, as opposite to DELETED. RECURSE descents into all nested multiparts to collect all parts.

You may also specify a code reference which is called for each nested part. The first argument will be the message part. When the code returns true, the part is incorporated in the return list.

Example:

 print "Number of attachments: ",
     scalar $message->body->parts('ACTIVE');

 foreach my $part ($message->body->parts) {
     print "Type: ", $part->get('Content-Type');
 }

$obj->preamble

Returns the preamble; the text before the first message part (before the first real attachment). The preamble is stored in a BODY object, and its encoding is taken from the multipart header.

$obj->print([FILEHANDLE])

See Access to the payload in the Mail::Message::Body manpage

$obj->printEscapedFrom(FILEHANDLE)

See Access to the payload in the Mail::Message::Body manpage

$obj->string

See Access to the payload in the Mail::Message::Body manpage

$obj->write(OPTIONS)

See Access to the payload in the Mail::Message::Body manpage

Internals

$obj->addTransferEncHandler(NAME, CLASS|OBJECT)

Mail::Message::Body::Multipart->addTransferEncHandler(NAME, CLASS|OBJECT)

See Internals in the Mail::Message::Body::Encode manpage

$obj->contentInfoFrom(HEAD)

$obj->contentInfoTo(HEAD)

$obj->fileLocation([BEGIN,END])

See Internals in the Mail::Message::Body::Encode manpage

$obj->getTransferEncHandler(TYPE)

$obj->isModified

$obj->load

$obj->modified([BOOLEAN])

$obj->moveLocation([DISTANCE])

$obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])

See Error handling in the Mail::Message::Body manpage

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Body::Multipart->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Body::Multipart->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Message::Body::Multipart->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings