|
Mail::Message::Part - a part of a message, but a message by itself |
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 Constructors in the Mail::Message manpage
Mail::Message::Part->new(OPTIONS)
Create a message part.
Option Defined in Default
body L<Mail::Message> undef
body_type L<Mail::Message> L<Mail::Message::Body::Lines|Mail::Message::Body::Lines>
container <required>
deleted L<Mail::Message> <false>
field_type L<Mail::Message> undef
head L<Mail::Message> <empty header>
head_type L<Mail::Message> L<Mail::Message::Head::Complete|Mail::Message::Head::Complete>
labels L<Mail::Message> {}
log L<Mail::Reporter> C<'WARNINGS'>
messageId L<Mail::Message> undef
modified L<Mail::Message> <false>
trace L<Mail::Reporter> C<'WARNINGS'>
trusted L<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 Constructing a message in the Mail::Message::Construct::Bounce manpage
Mail::Message::Part->build([MESSAGE|PART|BODY], CONTENT)
See Constructing a message in the Mail::Message::Construct::Build manpage
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 the Mail::Message::Construct::Forward manpage
$obj->forwardAttach(OPTIONS)
See Constructing a message in the Mail::Message::Construct::Forward manpage
$obj->forwardEncapsulate(OPTIONS)
See Constructing a message in the Mail::Message::Construct::Forward manpage
$obj->forwardInline(OPTIONS)
See Constructing a message in the Mail::Message::Construct::Forward manpage
$obj->forwardNo(OPTIONS)
See Constructing a message in the Mail::Message::Construct::Forward manpage
$obj->forwardPostlude
See Constructing a message in the Mail::Message::Construct::Forward manpage
$obj->forwardPrelude
See Constructing a message in the Mail::Message::Construct::Forward manpage
$obj->forwardSubject(STRING)
See Constructing a message in the Mail::Message::Construct::Forward manpage
Mail::Message::Part->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
See Constructing a message in the Mail::Message::Construct::Read manpage
$obj->rebuild(OPTIONS)
See Constructing a message in the Mail::Message::Construct::Rebuild manpage
$obj->reply(OPTIONS)
See Constructing a message in the Mail::Message::Construct::Reply manpage
$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
See Constructing a message in the Mail::Message::Construct::Reply manpage
$obj->replySubject(STRING)
Mail::Message::Part->replySubject(STRING)
See Constructing a message in the Mail::Message::Construct::Reply manpage
$obj->container
See The message in the Mail::Message manpage
$obj->isDummy
See The message in the Mail::Message manpage
$obj->isPart
See The message in the Mail::Message manpage
$obj->messageId
See The message in the Mail::Message manpage
$obj->print([FILEHANDLE])
See The message in the Mail::Message manpage
$obj->send([MAILER], OPTIONS)
See The message in the Mail::Message manpage
$obj->size
See The message in the Mail::Message manpage
$obj->toplevel
See The message in the Mail::Message manpage
$obj->write([FILEHANDLE])
See The message in the Mail::Message manpage
$obj->bcc
See The header in the Mail::Message manpage
$obj->cc
See The header in the Mail::Message manpage
$obj->date
See The header in the Mail::Message manpage
$obj->destinations
See The header in the Mail::Message manpage
$obj->from
See The header in the Mail::Message manpage
$obj->get(FIELDNAME)
See The header in the Mail::Message manpage
$obj->guessTimestamp
See The header in the Mail::Message manpage
$obj->head([HEAD])
See The header in the Mail::Message manpage
$obj->nrLines
See The header in the Mail::Message manpage
$obj->sender
See The header in the Mail::Message manpage
$obj->study(FIELDNAME)
See The header in the Mail::Message manpage
$obj->subject
See The header in the Mail::Message manpage
$obj->timestamp
See The header in the Mail::Message manpage
$obj->to
See The header in the Mail::Message manpage
$obj->body([BODY])
See The body in the Mail::Message manpage
$obj->decoded(OPTIONS)
See The body in the Mail::Message manpage
$obj->encode(OPTIONS)
See The body in the Mail::Message manpage
$obj->isMultipart
See The body in the Mail::Message manpage
$obj->isNested
See The body in the Mail::Message manpage
$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
See The body in the Mail::Message manpage
$obj->delete
See Flags in the Mail::Message manpage
$obj->deleted([BOOLEAN])
See Flags in the Mail::Message manpage
$obj->isDeleted
See Flags in the Mail::Message manpage
$obj->isModified
See Flags in the Mail::Message manpage
$obj->label(LABEL|PAIRS)
See Flags in the Mail::Message manpage
$obj->labels
See Flags in the Mail::Message manpage
$obj->labelsToStatus
See Flags in the Mail::Message manpage
$obj->modified([BOOLEAN])
See Flags in the Mail::Message manpage
$obj->statusToLabels
See Flags in the Mail::Message manpage
$obj->file
See The whole message as text in the Mail::Message::Construct::Text manpage
$obj->lines
See The whole message as text in the Mail::Message::Construct::Text manpage
$obj->printStructure([FILEHANDLE|undef],[INDENT])
See The whole message as text in the Mail::Message::Construct::Text manpage
$obj->string
See The whole message as text in the Mail::Message::Construct::Text manpage
$obj->clonedFrom
See Internals in the Mail::Message manpage
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 the Mail::Message manpage
$obj->readBody(PARSER, HEAD [, BODYTYPE])
See Internals in the Mail::Message manpage
$obj->readFromParser(PARSER, [BODYTYPE])
See Internals in the Mail::Message manpage
$obj->readHead(PARSER [,CLASS])
See Internals in the Mail::Message manpage
$obj->recursiveRebuildPart(PART, OPTIONS)
See Internals in the Mail::Message::Construct::Rebuild manpage
$obj->storeBody(BODY)
See Internals in the Mail::Message manpage
$obj->takeMessageId([STRING])
See Internals in the Mail::Message manpage
$obj->AUTOLOAD
See METHODS in the Mail::Message::Construct manpage
$obj->addReport(OBJECT)
See Error handling in the Mail::Reporter manpage
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Part->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::Part->log([LEVEL [,STRINGS]])
See Error handling in the Mail::Reporter manpage
$obj->logPriority(LEVEL)
Mail::Message::Part->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->shortSize([VALUE])
Mail::Message::Part->shortSize([VALUE])
See Error handling in the Mail::Message manpage
$obj->shortString
See Error handling in the Mail::Message manpage
$obj->trace([LEVEL])
See Error handling in the Mail::Reporter manpage
$obj->warnings
See Error handling in the Mail::Reporter manpage
$obj->DESTROY
See Cleanup in the Mail::Message manpage
$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 the Mail::Reporter manpage
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: 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: 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().
Error: forwardAttach requires a preamble object
Error: forwardEncapsulate requires a preamble object
Error: no rebuild rule $name defined.
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
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.
|
Mail::Message::Part - a part of a message, but a message by itself |