NAME

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

CLASS HIERARCHY

 Mail::Message::Body::Nested
 is a Mail::Message::Body + ::Construct + ::Encode
 is a Mail::Reporter

SYNOPSIS

 See Mail::Message::Body, plus

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

DESCRIPTION

READ Mail::Message::Body FIRST. This manual-page only describes the extentions to the default body functionality.

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.

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Reporter (MR), Mail::Message::Body (MMB), Mail::Message::Body::Construct (MMBC), Mail::Message::Body::Encode (MMBE).

The general methods for Mail::Message::Body::Nested objects:

 MMBC attach MESSAGES, OPTIONS         MMB lines
  MMB charset                           MR log [LEVEL [,STRINGS]]
 MMBE check                            MMB message [MESSAGE]
  MMB checked [BOOLEAN]                MMB mimeType
 MMBC concatenate COMPONENTS           MMB modified [BOOL]
  MMB decoded OPTIONS                      nested
  MMB disposition [STRING|FIELD]           new OPTIONS
 MMBE encode OPTIONS                   MMB nrLines
 MMBE encoded                          MMB print [FILE]
  MMB eol ['CR'|'LF'|'CRLF'|'NATI...   MMB reply OPTIONS
   MR errors                            MR report [LEVEL]
  MMB file                              MR reportAll [LEVEL]
      forNested CODE                   MMB size
 MMBC foreachLine CODE                 MMB string
 MMBE isBinary                        MMBC stripSignature OPTIONS
  MMB isDelayed                         MR trace [LEVEL]
  MMB isMultipart                      MMB transferEncoding [STRING|FI...
  MMB isNested                         MMB type
 MMBE isText                            MR warnings

The extra methods for extension writers:

   MR AUTOLOAD                         MMB load
   MR DESTROY                           MR logPriority LEVEL
 MMBE addTransferEncHandler NAME,...    MR logSettings
  MMB clone                            MMB moveLocation [DISTANCE]
  MMB fileLocation [BEGIN,END]          MR notImplemented
 MMBE getTransferEncHandler TYPE       MMB read PARSER, HEAD, BODYTYPE...
   MR inGlobalDestruction             MMBE unify BODY

METHODS

new OPTIONS

 OPTION      DESCRIBED IN                   DEFAULT
 based_on    Mail::Message::Body            undef
 charset     Mail::Message::Body            'us-ascii'
 data        Mail::Message::Body            undef
 disposition Mail::Message::Body            undef
 log         Mail::Reporter                 'WARNINGS'
 message     Mail::Message::Body            undef
 mime_type   Mail::Message::Body            'message/rfc822'
 modified    Mail::Message::Body            0
 nested      Mail::Message::Body::Nested    undef
 trace       Mail::Reporter                 'WARNINGS'
 transfer_encoding Mail::Message::Body      'NONE'

• nested => MESSAGE

  The message which is nested within this one. =back

  Example:

   my $intro = Mail::Message::Body->new(data => ...);
   my $body  = Mail::Message::Body::Nested->new(nested  => $intro);

• forNested CODE

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

• nested

  Returns the message which is enclosed within this body.

METHODS for extension writers

SEE ALSO

Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR

Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 2.018.

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