/ 
Mail-Box-2.092
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Body::Nested

NAME

Mail::Message::Body::Nested - body of a message which contains a message

INHERITANCE

Mail::Message::Body::Nested
  is a Mail::Message::Body
  is a Mail::Reporter

SYNOPSIS

See Mail::Message::Body

if($body->isNested) {
   my $nest = $body->nested;
   $nest->delete;
}

DESCRIPTION

The body (content) of a message can be stored in various ways. In this manual-page you find the description of extra functionality you have when a message contains a nested message, like message/rfc822.

A nested message is different from a multipart message which contains only one element, because a nested message has a full set of message header fields defined by the RFC882, where a part of a multipart has only a few. But because we do not keep track whether all fields are presented, a Mail::Message::Part is used anyway.

OVERLOADED

overload: ""

overload: '==' and '!='

overload: @{}

overload: bool

METHODS

Constructors

$obj->clone

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

    Option           --Defined in     --Default
based_on           Mail::Message::Body  undef
charset            Mail::Message::Body  'PERL' or <undef>
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'
file               Mail::Message::Body  undef
log                Mail::Reporter   'WARNINGS'
message            Mail::Message::Body  undef
mime_type          Mail::Message::Body  'message/rfc822'
modified           Mail::Message::Body  <false>
nested                              undef
trace              Mail::Reporter   'WARNINGS'
transfer_encoding  Mail::Message::Body  'none'

    . based_on => BODY

    . charset => CHARSET|'PERL'

    . checked => BOOLEAN

    . data => ARRAY-OF-LINES | STRING

    . description => STRING|FIELD

    . disposition => STRING|FIELD

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

    . file => FILENAME|FILEHANDLE|IOHANDLE

    . log => LEVEL

    . message => MESSAGE

    . mime_type => STRING|FIELD|MIME

    . modified => BOOLEAN

    . nested => MESSAGE

      The message which is encapsulated within this body.

    . trace => LEVEL

    . transfer_encoding => STRING|FIELD

    example:

    my $msg   = $folder->message(3);
my $encaps= Mail::Message::Body::Nested->new(nested => $msg);

# The body will be coerced into a message, which lacks a few
# lines but we do not bother.
my $intro = Mail::Message::Body->new(data => ...);
my $body  = Mail::Message::Body::Nested->new(nested  => $intro);

Constructing a body

$obj->attach(MESSAGES, OPTIONS)

$obj->check

$obj->concatenate(COMPONENTS)

$obj->decoded(OPTIONS)

$obj->encode(OPTIONS)

$obj->encoded

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

$obj->foreachLine((CODE))

    It is NOT possible to call some code for each line of a nested because that would damage the header of the encapsulated message

$obj->stripSignature(OPTIONS)

$obj->unify(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])

$obj->dispositionFilename([DIRECTORY])

$obj->isBinary

$obj->isText

$obj->mimeType

$obj->nrLines

$obj->size

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

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

Access to the payload

$obj->endsOnNewline

$obj->file

$obj->forNested(CODE)

    Execute the CODE for the nested message. This returns a new nested body object. Returns undef when the CODE returns undef.

$obj->lines

$obj->nested

$obj->print([FILEHANDLE])

$obj->printEscapedFrom(FILEHANDLE)

$obj->string

$obj->stripTrailingNewline

$obj->write(OPTIONS)

Internals

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

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

$obj->contentInfoFrom(HEAD)

$obj->contentInfoTo(HEAD)

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

$obj->getTransferEncHandler(TYPE)

$obj->isModified

$obj->load

$obj->modified([BOOLEAN])

$obj->moveLocation([DISTANCE])

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

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

DETAILS

DIAGNOSTICS

Warning: Charset $name is not known

    The encoding or decoding of a message body encounters a character set which is not understood by Perl's Encode module.

Warning: No decoder defined for transfer encoding $name.

    The data (message body) is encoded in a way which is not currently understood, therefore no decoding (or recoding) can take place.

Warning: No encoder defined for transfer encoding $name.

    The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned.

Error: Package $package does not implement $method.

    Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

Warning: Unknown line terminator $eol ignored

Error: You cannot use foreachLine on a nested

    foreachLine() should be used on decoded message bodies only, because it would modify the header of the encapsulated message. which is clearly not acceptible.

SEE ALSO

This module is part of Mail-Box distribution version 2.092, built on November 20, 2009. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2009 by Mark Overmeer. 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://www.perl.com/perl/misc/Artistic.html