Mail::Message::Part - a part of a message, but a message by itself
Mail::Message::Part is a Mail::Message is a Mail::Reporter
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
}
}
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.
$obj->printEscapedFrom(FILEHANDLE)
Prints the message part, but all lines which start with 'From ' will get
a leading gt. See Mail::Message::Body::printEscapedFrom().
$obj->clone(OPTIONS)
See Mail::Message/"Constructors"
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
$obj->bounce([RG-OBJECT|OPTIONS])
See Mail::Message::Construct::Bounce/"Constructing a message"
Mail::Message::Part->build([MESSAGE|PART|BODY], CONTENT)
See Mail::Message::Construct::Build/"Constructing a message"
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 Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardAttach(OPTIONS)
See Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardEncapsulate(OPTIONS)
See Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardInline(OPTIONS)
See Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardNo(OPTIONS)
See Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardPostlude
See Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardPrelude
See Mail::Message::Construct::Forward/"Constructing a message"
$obj->forwardSubject(STRING)
See Mail::Message::Construct::Forward/"Constructing a message"
Mail::Message::Part->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
See Mail::Message::Construct::Read/"Constructing a message"
$obj->rebuild(OPTIONS)
See Mail::Message::Construct::Rebuild/"Constructing a message"
$obj->reply(OPTIONS)
See Mail::Message::Construct::Reply/"Constructing a message"
$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
See Mail::Message::Construct::Reply/"Constructing a message"
$obj->replySubject(STRING)
Mail::Message::Part->replySubject(STRING)
See Mail::Message::Construct::Reply/"Constructing a message"
$obj->container
See Mail::Message/"The message"
$obj->isDummy
See Mail::Message/"The message"
$obj->isPart
See Mail::Message/"The message"
$obj->messageId
See Mail::Message/"The message"
$obj->print([FILEHANDLE])
See Mail::Message/"The message"
$obj->send([MAILER], OPTIONS)
See Mail::Message/"The message"
$obj->size
See Mail::Message/"The message"
$obj->toplevel
See Mail::Message/"The message"
$obj->write([FILEHANDLE])
See Mail::Message/"The message"
$obj->bcc
See Mail::Message/"The header"
$obj->cc
See Mail::Message/"The header"
$obj->date
See Mail::Message/"The header"
$obj->destinations
See Mail::Message/"The header"
$obj->from
See Mail::Message/"The header"
$obj->get(FIELDNAME)
See Mail::Message/"The header"
$obj->guessTimestamp
See Mail::Message/"The header"
$obj->head([HEAD])
See Mail::Message/"The header"
$obj->nrLines
See Mail::Message/"The header"
$obj->sender
See Mail::Message/"The header"
$obj->study(FIELDNAME)
See Mail::Message/"The header"
$obj->subject
See Mail::Message/"The header"
$obj->timestamp
See Mail::Message/"The header"
$obj->to
See Mail::Message/"The header"
$obj->body([BODY])
$obj->contentType
$obj->decoded(OPTIONS)
$obj->encode(OPTIONS)
$obj->isMultipart
$obj->isNested
$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
$obj->delete
$obj->deleted([BOOLEAN])
$obj->isDeleted
$obj->isModified
$obj->label(LABEL|PAIRS)
$obj->labels
$obj->labelsToStatus
$obj->modified([BOOLEAN])
$obj->statusToLabels
$obj->file
See Mail::Message::Construct::Text/"The whole message as text"
$obj->lines
See Mail::Message::Construct::Text/"The whole message as text"
$obj->printStructure([FILEHANDLE|undef],[INDENT])
See Mail::Message::Construct::Text/"The whole message as text"
$obj->string
See Mail::Message::Construct::Text/"The whole message as text"
$obj->clonedFrom
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
$obj->readBody(PARSER, HEAD [, BODYTYPE])
$obj->readFromParser(PARSER, [BODYTYPE])
$obj->readHead(PARSER [,CLASS])
$obj->recursiveRebuildPart(PART, OPTIONS)
See Mail::Message::Construct::Rebuild/"Internals"
$obj->storeBody(BODY)
$obj->takeMessageId([STRING])
$obj->AUTOLOAD
See Mail::Message::Construct/"METHODS"
$obj->addReport(OBJECT)
See Mail::Reporter/"Error handling"
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Part->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See Mail::Reporter/"Error handling"
$obj->errors
See Mail::Reporter/"Error handling"
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Part->log([LEVEL [,STRINGS]])
See Mail::Reporter/"Error handling"
$obj->logPriority(LEVEL)
Mail::Message::Part->logPriority(LEVEL)
See Mail::Reporter/"Error handling"
$obj->logSettings
See Mail::Reporter/"Error handling"
$obj->notImplemented
See Mail::Reporter/"Error handling"
$obj->report([LEVEL])
See Mail::Reporter/"Error handling"
$obj->reportAll([LEVEL])
See Mail::Reporter/"Error handling"
$obj->shortSize([VALUE])
Mail::Message::Part->shortSize([VALUE])
See Mail::Message/"Error handling"
$obj->shortString
See Mail::Message/"Error handling"
$obj->trace([LEVEL])
See Mail::Reporter/"Error handling"
$obj->warnings
See Mail::Reporter/"Error handling"
$obj->DESTROY
$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
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().
This module is part of Mail-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/
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