unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Mail::Message::Part(3pUser Contributed Perl DocumentatMail::Message::Part(3pm)



NAME
       Mail::Message::Part - a part of a message, but a message by itself

INHERITANCE
        Mail::Message::Part
          is a Mail::Message
          is a Mail::Reporter

SYNOPSIS
        my Mail::Message $message = ...;
        if($message->isMultipart) {
           my Mail::Message::Part $part;

           foreach $part ($message->body->parts) {
              $part->print(\*OUT);
              my $attached_head = $part->head;
              my $attached_body = $part->body;      # encoded as read
              my $attached_body = $part->decoded;   # transfer-encoding removed
           }
        }

DESCRIPTION
       A "Mail::Message::Part" object contains a message which is included in
       the body of an other message.  For instance attachments are parts.

       READ Mail::Message FIRST.  A part is a special message: it has a
       reference to its parent message, and will usually not be sub-classed
       into mail folder specific variants.

METHODS
       $obj->printEscapedFrom(FILEHANDLE)

           Prints the message part, but all lines which start with 'From '
           will get a leading "gt".  See
           Mail::Message::Body::printEscapedFrom().

       Constructors

       $obj->clone(OPTIONS)

           See "Constructors" in Mail::Message

       Mail::Message::Part->new(OPTIONS)

           Create a message part.

            Option    --Defined in     --Default
            body        Mail::Message    undef
            body_type   Mail::Message    Mail::Message::Body::Lines
            container                    <required>
            deleted     Mail::Message    <false>
            field_type  Mail::Message    undef
            head        Mail::Message    <empty header>
            head_type   Mail::Message    Mail::Message::Head::Complete
            labels      Mail::Message    {}
            log         Mail::Reporter   'WARNINGS'
            messageId   Mail::Message    undef
            modified    Mail::Message    <false>
            trace       Mail::Reporter   'WARNINGS'
            trusted     Mail::Message    <false>

           . body => OBJECT

           . body_type => CLASS

           . container => BODY

               Reference to the parental Mail::Message::Body object where this
               part is a member of.  That object may be a
               Mail::Message::Body::Multipart or a
               Mail::Message::Body::Nested.

           . deleted => BOOLEAN

           . field_type => CLASS

           . head => OBJECT

           . head_type => CLASS

           . labels => ARRAY|HASH

           . log => LEVEL

           . messageId => STRING

           . modified => BOOLEAN

           . trace => LEVEL

           . trusted => BOOLEAN

       Constructing a message

       $obj->bounce([RG-OBJECT|OPTIONS])

           See "Constructing a message" in Mail::Message::Construct::Bounce

       Mail::Message::Part->build([MESSAGE|PART|BODY], CONTENT)

           See "Constructing a message" in Mail::Message::Construct::Build

       Mail::Message::Part->buildFromBody(BODY, CONTAINER, HEADERS)

           Shape a message part around a BODY.  Bodies have information about
           their content in them, which is used to construct a header for the
           message.  Next to that, more HEADERS can be specified.  No headers
           are obligatory.  No extra headers are fabricated automatically.

           example:

            my $multi = Mail::Message::Body::Multipart->new;
            my $part  = Mail::Message::Part->buildFromBody($body, $multi);

       $obj->forward(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardAttach(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardEncapsulate(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardInline(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardNo(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardPostlude

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardPrelude

           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardSubject(STRING)

           See "Constructing a message" in Mail::Message::Construct::Forward

       Mail::Message::Part->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES,
       OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Read

       $obj->rebuild(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Rebuild

       $obj->reply(OPTIONS)

           See "Constructing a message" in Mail::Message::Construct::Reply

       $obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])

           See "Constructing a message" in Mail::Message::Construct::Reply

       $obj->replySubject(STRING)

       Mail::Message::Part->replySubject(STRING)

           See "Constructing a message" in Mail::Message::Construct::Reply

       The message

       $obj->container

           See "The message" in Mail::Message

       $obj->isDummy

           See "The message" in Mail::Message

       $obj->isPart

           See "The message" in Mail::Message

       $obj->messageId

           See "The message" in Mail::Message

       $obj->print([FILEHANDLE])

           See "The message" in Mail::Message

       $obj->send([MAILER], OPTIONS)

           See "The message" in Mail::Message

       $obj->size

           See "The message" in Mail::Message

       $obj->toplevel

           See "The message" in Mail::Message

       $obj->write([FILEHANDLE])

           See "The message" in Mail::Message

       The header

       $obj->bcc

           See "The header" in Mail::Message

       $obj->cc

           See "The header" in Mail::Message

       $obj->date

           See "The header" in Mail::Message

       $obj->destinations

           See "The header" in Mail::Message

       $obj->from

           See "The header" in Mail::Message

       $obj->get(FIELDNAME)

           See "The header" in Mail::Message

       $obj->guessTimestamp

           See "The header" in Mail::Message

       $obj->head([HEAD])

           See "The header" in Mail::Message

       $obj->nrLines

           See "The header" in Mail::Message

       $obj->sender

           See "The header" in Mail::Message

       $obj->study(FIELDNAME)

           See "The header" in Mail::Message

       $obj->subject

           See "The header" in Mail::Message

       $obj->timestamp

           See "The header" in Mail::Message

       $obj->to

           See "The header" in Mail::Message

       The body

       $obj->body([BODY])

           See "The body" in Mail::Message

       $obj->contentType

           See "The body" in Mail::Message

       $obj->decoded(OPTIONS)

           See "The body" in Mail::Message

       $obj->encode(OPTIONS)

           See "The body" in Mail::Message

       $obj->isMultipart

           See "The body" in Mail::Message

       $obj->isNested

           See "The body" in Mail::Message

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

           See "The body" in Mail::Message

       Flags

       $obj->delete

           See "Flags" in Mail::Message

       $obj->deleted([BOOLEAN])

           See "Flags" in Mail::Message

       $obj->isDeleted

           See "Flags" in Mail::Message

       $obj->isModified

           See "Flags" in Mail::Message

       $obj->label(LABEL|PAIRS)

           See "Flags" in Mail::Message

       $obj->labels

           See "Flags" in Mail::Message

       $obj->labelsToStatus

           See "Flags" in Mail::Message

       $obj->modified([BOOLEAN])

           See "Flags" in Mail::Message

       $obj->statusToLabels

           See "Flags" in Mail::Message

       The whole message as text

       $obj->file

           See "The whole message as text" in Mail::Message::Construct::Text

       $obj->lines

           See "The whole message as text" in Mail::Message::Construct::Text

       $obj->printStructure([FILEHANDLE|undef],[INDENT])

           See "The whole message as text" in Mail::Message::Construct::Text

       $obj->string

           See "The whole message as text" in Mail::Message::Construct::Text

       Internals

       $obj->clonedFrom

           See "Internals" in Mail::Message

       Mail::Message::Part->coerce(BODY|MESSAGE, MULTIPART, HEADERS)

           Transforms a BODY or MESSAGE to a real message part.  The MULTIPART
           refers to the parental body.

           When ta BODY is specified, extra HEADERS can be supplied as well.
           Bodies are coerced into message parts by calling buildFromBody().
           If you specify a MESSAGE residing in a folder, this message will
           automatically be cloned.

       $obj->isDelayed

           See "Internals" in Mail::Message

       $obj->readBody(PARSER, HEAD [, BODYTYPE])

           See "Internals" in Mail::Message

       $obj->readFromParser(PARSER, [BODYTYPE])

           See "Internals" in Mail::Message

       $obj->readHead(PARSER [,CLASS])

           See "Internals" in Mail::Message

       $obj->recursiveRebuildPart(PART, OPTIONS)

           See "Internals" in Mail::Message::Construct::Rebuild

       $obj->storeBody(BODY)

           See "Internals" in Mail::Message

       $obj->takeMessageId([STRING])

           See "Internals" in Mail::Message

       Error handling

       $obj->AUTOLOAD

           See "METHODS" in Mail::Message::Construct

       $obj->addReport(OBJECT)

           See "Error handling" in Mail::Reporter

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

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

           See "Error handling" in Mail::Reporter

       $obj->errors

           See "Error handling" in Mail::Reporter

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

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

           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)

       Mail::Message::Part->logPriority(LEVEL)

           See "Error handling" in Mail::Reporter

       $obj->logSettings

           See "Error handling" in Mail::Reporter

       $obj->notImplemented

           See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->shortSize([VALUE])

       Mail::Message::Part->shortSize([VALUE])

           See "Error handling" in Mail::Message

       $obj->shortString

           See "Error handling" in Mail::Message

       $obj->trace([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->warnings

           See "Error handling" in Mail::Reporter

       Cleanup

       $obj->DESTROY

           See "Cleanup" in Mail::Message

       $obj->destruct

           Message parts can not be destructed per part: only whole messages
           can be forcefully freed from memory.  Of course, you can delete()
           separate parts, which only sets a flag not to write a part again.
           Furthermore, you may cosider rebuild() to get rit of deleted parts.

       $obj->inGlobalDestruction

           See "Cleanup" in Mail::Reporter

DETAILS
DIAGNOSTICS
       Error: Cannot include forward source as $include.

           Unknown alternative for the forward(include).  Valid choices are
           "NO", "INLINE", "ATTACH", and "ENCAPSULATE".

       Error: Cannot include reply source as $include.

           Unknown alternative for the "include" option of reply().  Valid
           choices are "NO", "INLINE", and "ATTACH".

       Error: Method bounce requires To, Cc, or Bcc

           The message bounce() method forwards a received message off to
           someone else without modification; you must specified it's new
           destination.  If you have the urge not to specify any destination,
           you probably are looking for reply(). When you wish to modify the
           content, use forward().

       Error: Method forwardAttach requires a preamble

       Error: Method forwardEncapsulate requires a preamble

       Error: No address to create forwarded to.

           If a forward message is created, a destination address must be
           specified.

       Error: No default mailer found to send message.

           The message send() mechanism had not enough information to
           automatically find a mail transfer agent to sent this message.
           Specify a mailer explicitly using the "via" options.

       Error: No rebuild rule $name defined.

       Error: Only build() Mail::Message's; they are not in a folder yet

           You may wish to construct a message to be stored in a some kind of
           folder, but you need to do that in two steps.  First, create a
           normal Mail::Message, and then add it to the folder.  During this
           Mail::Box::addMessage() process, the message will get coerce()-d
           into the right message type, adding storage information and the
           like.

       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.

       Error: You cannot destruct message parts, only whole messages

           Message parts can not be destructed per part: only whole messages
           can be forcefully freed from memory. Consider delete() or
           rebuild().

SEE ALSO
       This module is part of Mail-Box distribution version 2.082, built on
       April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE
       Copyrights 2001-2008 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



perl v5.10.0                      2008-04-28          Mail::Message::Part(3pm)