NAME

overload: '==' and '!='

overload: @{}

overload: bool

See Mail::Message::Body::Encode/"Constructing a body"

METHODS

Constructors

$obj->clone

See Mail::Message::Body/"Constructors"

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

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

. description => STRING|FIELD

. 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

$obj->concatenate(COMPONENTS)

See Mail::Message::Body::Construct/"Constructing a body"

$obj->decoded(OPTIONS)

See Mail::Message::Body/"Constructing a body"

$obj->encode(OPTIONS)

See Mail::Message::Body::Encode/"Constructing a body"

$obj->encoded

See Mail::Message::Body::Encode/"Constructing a body"

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

See Mail::Message::Body/"Constructing a body"

$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))

It is NOT possible to call some code for each line of a multipart, because that would not only inflict damage to the body of each message part, but also to the headers and the part separators.

$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    Mail::Message::Body::Construct  10
 pattern      Mail::Message::Body::Construct  qr/^--\s?$/
 result_type  Mail::Message::Body::Construct  <same as current>

. max_lines => INTEGER|undef

. pattern => REGEX|STRING|CODE

. result_type => CLASS

$obj->unify(BODY)

See Mail::Message::Body::Encode/"Constructing a body"

The body

$obj->isDelayed

$obj->isMultipart

$obj->isNested

$obj->message([MESSAGE])

About the payload

$obj->charset

$obj->checked([BOOLEAN])

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

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

See Mail::Message::Body::Encode/"About the payload"

$obj->dispositionFilename([DIRECTORY])

$obj->isBinary

See Mail::Message::Body::Encode/"About the payload"

$obj->isText

See Mail::Message::Body::Encode/"About the payload"

$obj->mimeType

$obj->nrLines

$obj->size

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

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

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->endsOnNewline

$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

$obj->lines

$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])

$obj->printEscapedFrom(FILEHANDLE)

$obj->string

$obj->stripTrailingNewline

$obj->write(OPTIONS)

See Mail::Message::Body::Encode/"Internals"

Internals

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

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

$obj->contentInfoFrom(HEAD)

$obj->contentInfoTo(HEAD)

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

See Mail::Message::Body::Encode/"Internals"

$obj->getTransferEncHandler(TYPE)

$obj->isModified

$obj->load

$obj->modified([BOOLEAN])

$obj->moveLocation([DISTANCE])

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

See Mail::Message::Body/"Error handling"

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