Mail::Box::Net::Message - one message from a distant folder
Mail::Box::Net::Message is a Mail::Box::Message is a Mail::Message is a Mail::Reporter Mail::Box::Net::Message is extended by Mail::Box::IMAP4::Message Mail::Box::POP3::Message
my $folder = new Mail::Box::POP3 ... my $message = $folder->message(10);
A Mail::Box::Net::Message represents one message in a folder which can only be accessed via some kind of protocol. On this moment, only a POP3 client is available. IMAP, DBI, and NNTP are other candidates.
$obj->clone(OPTIONS)
See Mail::Message/"Constructors"
Mail::Box::Net::Message->new(OPTIONS)
Option --Defined in --Default body Mail::Message undef body_type Mail::Box::Message <from folder> deleted Mail::Message <false> field_type Mail::Message undef folder Mail::Box::Message <required> head Mail::Message undef head_type Mail::Message Mail::Message::Head::Complete labels Mail::Message {} log Mail::Reporter 'WARNINGS' messageId Mail::Message undef modified Mail::Message <false> size Mail::Box::Message undef trace Mail::Reporter 'WARNINGS' trusted Mail::Message <false> unique <unique string>
. body => OBJECT
. body_type => CODE|CLASS
. deleted => BOOLEAN
. field_type => CLASS
. folder => FOLDER
. head => OBJECT
. head_type => CLASS
. labels => ARRAY|HASH
. log => LEVEL
. messageId => STRING
. modified => BOOLEAN
. size => INTEGER
. trace => LEVEL
. trusted => BOOLEAN
. unique => STRING
The unique keys which identifies this message on the remote server.
$obj->bounce([RG-OBJECT|OPTIONS])
See Mail::Message::Construct::Bounce/"Constructing a message"
Mail::Box::Net::Message->build([MESSAGE|PART|BODY], CONTENT)
See Mail::Message::Construct::Build/"Constructing a message"
Mail::Box::Net::Message->buildFromBody(BODY, [HEAD], HEADERS)
See Mail::Message::Construct::Build/"Constructing a message"
$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::Box::Net::Message->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::Box::Net::Message->replySubject(STRING)
See Mail::Message::Construct::Reply/"Constructing a message"
$obj->container
See Mail::Message/"The message"
$obj->copyTo(FOLDER, OPTIONS)
See Mail::Box::Message/"The message"
$obj->folder([FOLDER])
See Mail::Box::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->moveTo(FOLDER, OPTIONS)
See Mail::Box::Message/"The message"
$obj->print([FILEHANDLE])
See Mail::Message/"The message"
$obj->send([MAILER], OPTIONS)
See Mail::Message/"The message"
$obj->seqnr([INTEGER])
See Mail::Box::Message/"The message"
$obj->size
See Mail::Message/"The message"
$obj->toplevel
See Mail::Message/"The message"
$obj->unique([STRING|undef])
Returns the name of the file in which this message is actually stored. This
will return undef
when the message is not stored in a file. When a STRING
is specified, a new identifier is stored first.
$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::Box::Net::Message->coerce(MESSAGE, OPTIONS)
$obj->diskDelete
See Mail::Box::Message/"Internals"
$obj->isDelayed
$obj->loadBody
$obj->readBody(PARSER, HEAD [, BODYTYPE])
See Mail::Box::Message/"Internals"
$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::Box::Net::Message->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See Mail::Reporter/"Error handling"
$obj->errors
See Mail::Reporter/"Error handling"
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Net::Message->log([LEVEL [,STRINGS]])
See Mail::Reporter/"Error handling"
$obj->logPriority(LEVEL)
Mail::Box::Net::Message->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::Box::Net::Message->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
See Mail::Box::Message/"Cleanup"
$obj->inGlobalDestruction
Error: Cannot coerce a $class object into a $class object
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: Unable to read delayed body.
Error: Unable to read delayed head.
Error: coercion starts with some object
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