• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• OVERLOADED
• METHODS
• Constructors
• Constructing a body
• The body
• About the payload
• Access to the payload
• Internals
• Error handling
• Cleanup
• DIAGNOSTICS
• DETAILS
• REFERENCES
• COPYRIGHTS

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: ``''

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

overload: '==' and '!='

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

overload: @{}

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

overload: bool

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

METHODS

Constructors

$obj->clone

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

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

 Option             Defined in       Default            
 based_on           L<Mail::Message::Body>  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'>        
 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<'message/rfc822'>
 modified           L<Mail::Message::Body>  <false>            
 nested                              undef              
 trace              L<Mail::Reporter>  C<'WARNINGS'>      
 transfer_encoding  L<Mail::Message::Body>  C<'none'>

. based_on BODY

. charset STRING

. checked BOOLEAN

. data ARRAY-OF-LINES | STRING

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

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

$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->foreachLine(CODE)

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

$obj->stripSignature(OPTIONS)

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

$obj->unify(BODY)

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

The body

$obj->isDelayed

See The body in the Mail::Message::Body manpage

$obj->isMultipart

See The body in the Mail::Message::Body manpage

$obj->isNested

See The body in the Mail::Message::Body manpage

$obj->message([MESSAGE])

See The body in the Mail::Message::Body manpage

About the payload

$obj->charset

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

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

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

$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

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

$obj->nested

Returns the Mail::Message::Part message which is enclosed within this body.

$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::Nested->addTransferEncHandler(NAME, CLASS|OBJECT)

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

$obj->contentInfoFrom(HEAD)

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

$obj->contentInfoTo(HEAD)

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

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

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

$obj->getTransferEncHandler(TYPE)

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

$obj->isModified

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

$obj->load

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

$obj->modified([BOOLEAN])

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

$obj->moveLocation([DISTANCE])

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

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

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

Error handling

$obj->AUTOLOAD

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

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

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

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Reporter manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

DIAGNOSTICS

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.

DETAILS

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.