The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Mail-Box-2.070
River stage one • 8 direct dependents • 8 total dependents
16 ++
/ Mail::Message::Dummy

NAME

Mail::Message::Dummy - a placeholder for a missing messages

INHERITANCE

 Mail::Message::Dummy
   is a Mail::Message
   is a Mail::Reporter

SYNOPSIS

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(OPTIONS)

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) {...}

Constructing a message

$obj->bounce([RG-OBJECT|OPTIONS])

Mail::Message::Dummy->build([MESSAGE|PART|BODY], CONTENT)

Mail::Message::Dummy->buildFromBody(BODY, [HEAD], HEADERS)

$obj->forward(OPTIONS)

$obj->forwardAttach(OPTIONS)

$obj->forwardEncapsulate(OPTIONS)

$obj->forwardInline(OPTIONS)

$obj->forwardNo(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|ARRAY-OF-THINGS])

$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->delete

$obj->deleted([BOOLEAN])

$obj->isDeleted

$obj->isModified

$obj->label(LABEL|PAIRS)

$obj->labels

$obj->labelsToStatus

$obj->modified([BOOLEAN])

$obj->statusToLabels

The whole message as text

$obj->file

$obj->lines

$obj->printStructure([FILEHANDLE|undef],[INDENT])

$obj->string

Internals

$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)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Dummy->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$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

DETAILS

DIAGNOSTICS

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.

SEE ALSO

This module is part of Mail-Box distribution version 2.070, built on March 25, 2007. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2007 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