NAME
Mail::Message::Dummy - a placeholder for a missing messages
INHERITANCE
Mail::Message::Dummy
is a Mail::Message
is a Mail::ReporterSYNOPSIS
DESCRIPTION
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.
METHODS
Constructors
$obj->clone
Mail::Message::Dummy->coerce(MESSAGE)
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 L<Mail::Message> <not used>
body_type L<Mail::Message> L<Mail::Message::Body::Lines|Mail::Message::Body::Lines>
field_type L<Mail::Message> <not used>
head L<Mail::Message> <not used>
head_type L<Mail::Message> <not used>
labels L<Mail::Message> {}
log L<Mail::Reporter> C<'WARNINGS'>
messageId L<Mail::Message> <required>
modified L<Mail::Message> <always false>
trace L<Mail::Reporter> C<'WARNINGS'>
trusted L<Mail::Message> <always true> . body OBJECT
. body_type CLASS
. 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) {...}Constructing a message
$obj->bounce([RG-OBJECT|OPTIONS])
Mail::Message::Dummy->build([MESSAGE|BODY], CONTENT)
Mail::Message::Dummy->buildFromBody(BODY, [HEAD], HEADERS)
$obj->forward(OPTIONS)
$obj->forwardPostlude
$obj->forwardPrelude
$obj->forwardSubject(STRING)
Mail::Message::Dummy->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::Dummy->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(FIELDNAME)
$obj->guessTimestamp
$obj->head(...)
$obj->nrLines
$obj->sender
$obj->study(FIELDNAME)
$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->isDeleted
$obj->isModified
$obj->label(LABEL [,VALUE [LABEL, VALUE] ])
$obj->labels
$obj->modified([BOOLEAN])
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::Dummy->defaultTrace([LEVEL, [LEVEL])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Dummy->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Message::Dummy->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->shortSize([VALUE])
Mail::Message::Dummy->shortSize([VALUE])
$obj->shortString
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->destruct
$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: 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: 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: 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: no rebuild rule $name defined.
DETAILS
REFERENCES
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Distribution version 2.046. 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.