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::ReporterSYNOPSIS
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
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.
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>
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>
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.
. field_type CLASS
. head OBJECT
. head_type CLASS
. log LEVEL
. messageId STRING
. modified BOOLEAN
. trace LEVEL
. trusted BOOLEAN
Constructing a message
$obj->bounce([RG-OBJECT|OPTIONS])
Mail::Message::Part->build([MESSAGE|BODY], CONTENT)
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)
$obj->forwardPostlude
$obj->forwardPrelude
$obj->forwardSubject(STRING)
Mail::Message::Part->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
$obj->rebuild(OPTIONS)
$obj->reply(OPTIONS)
$obj->replyPrelude([STRING|FIELD|ADDRESS])
$obj->replySubject(STRING)
Mail::Message::Part->replySubject(STRING)
The Message
$obj->container
$obj->isDummy
$obj->isPart
$obj->messageId
$obj->print([FILEHANDLE])
$obj->send([MAILER], OPTIONS)
$obj->size
$obj->toplevel
$obj->write([FILEHANDLE])
The header
$obj->bcc
$obj->cc
$obj->date
$obj->destinations
$obj->from
$obj->get(FIELD)
$obj->guessTimestamp
$obj->head([HEAD])
$obj->nrLines
$obj->sender
$obj->subject
$obj->timestamp
$obj->to
The body
$obj->body([BODY])
$obj->decoded(OPTIONS)
$obj->encode(OPTIONS)
$obj->isMultipart
$obj->isNested
$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
Flags
$obj->delete
Do not print or send this part of the message anymore. See deleted(). The time stamp of the moment of deletion is stored as value. When the same message is deleted more than once, the first time stamp will stay.
Example:
$message->part(2)->delete;
$part->deleted(1);
delete $part;$obj->deleted([BOOLEAN])
Set the delete flag for this part of the multipart message body. Without argument, the method returns the same is the isDeleted() method, which is prefered. When a true value is given, delete() is called.
$obj->isDeleted
Returns the moment (as the time function returns) when the message part was flagged for deletion, or undef when the part is not deleted.
Example:
next if $part->isDeleted;
if(my $when = $part->isDeleted) {
print scalar localtime $when;
}$obj->isModified
$obj->label(LABEL [,VALUE [LABEL, VALUE] ])
$obj->labels
$obj->labelsToStatus
$obj->modified([BOOLEAN])
$obj->statusToLabels
The whole message as text
$obj->file
$obj->lines
$obj->printStructure([FILEHANDLE][, INDENT])
$obj->string
Internals
$obj->isDelayed
$obj->readBody(PARSER, HEAD [, BODYTYPE])
$obj->readFromParser(PARSER, [BODYTYPE])
$obj->readHead(PARSER [,CLASS])
$obj->recursiveRebuildPart(PART, OPTIONS)
$obj->storeBody(BODY)
$obj->takeMessageId([STRING])
Error handling
$obj->AUTOLOAD
$obj->defaultTrace([LEVEL, [LEVEL])
Mail::Message::Part->defaultTrace([LEVEL, [LEVEL])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Part->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Message::Part->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->inGlobalDestruction
DIAGNOSTICS
Error: Cannot include forward source as $include.
Unknown alternative for the forward(include). Valid choices are NO, INLINE, and ATTACH.
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: 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: no rebuild rule $name defined.
DETAILS
REFERENCES
See the Mail::Box website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Module version 2.041. 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.