Mail::Message::Dummy - a placeholder for a missing messages
Mail::Message::Dummy is a Mail::Message is a Mail::Reporter
Dummy messages are used by modules which maintain ordered lists of messages, usually based on message-id. A good example is Mail::Box::Thread::Manager, which detects related messages by scanning the known message headers for references to other messages. As long as the referenced messages are not found inside the mailbox, their place is occupied by a dummy.
Be careful when using modules which may create dummies. Before trying to access the header or body use isDummy() to check if the message is a dummy message.
$obj->clone(OPTIONS)
See Mail::Message/"Constructors"
Mail::Message::Dummy->new(MESSAGE-ID, OPTIONS)
Create a new dummy message to occupy the space for a real message with the specified MESSAGE-ID.
Option --Defined in --Default
body Mail::Message <not used>
body_type Mail::Message Mail::Message::Body::Lines
deleted Mail::Message <false>
field_type Mail::Message <not used>
head Mail::Message <not used>
head_type Mail::Message <not used>
labels Mail::Message {}
log Mail::Reporter 'WARNINGS'
messageId Mail::Message <required>
modified Mail::Message <always false>
trace Mail::Reporter 'WARNINGS'
trusted Mail::Message <always true>
. body => OBJECT
. body_type => CLASS
. deleted => BOOLEAN
. field_type => CLASS
. head => OBJECT
. head_type => CLASS
. labels => ARRAY|HASH
. log => LEVEL
. messageId => STRING
. modified => BOOLEAN
. trace => LEVEL
. trusted => BOOLEAN
example:
my $message = Mail::Message::Dummy->new($msgid);
if($message->isDummy) {...}
$obj->bounce([RG-OBJECT|OPTIONS])
See Mail::Message::Construct::Bounce/"Constructing a message"
Mail::Message::Dummy->build([MESSAGE|PART|BODY], CONTENT)
See Mail::Message::Construct::Build/"Constructing a message"
Mail::Message::Dummy->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::Message::Dummy->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::Dummy->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(...)
$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::Dummy->coerce(MESSAGE, OPTIONS)
$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::Dummy->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See Mail::Reporter/"Error handling"
$obj->errors
See Mail::Reporter/"Error handling"
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Dummy->log([LEVEL [,STRINGS]])
See Mail::Reporter/"Error handling"
$obj->logPriority(LEVEL)
Mail::Message::Dummy->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::Dummy->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
$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: Message-Id is required for a dummy.
A dummy message occupies the place for a real message. When a dummy is created, the id of the message which place it is holding must be known.
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 take the head/body of a dummy message
Dummy messages are place-holders in message threads: the thread detected the existence of the message, because it found the message-id in a Reply-To or References field, however it did not find the header and body of the message yet. Use isDummy() to check whether the thread node returned a dummy or not.
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