Provided by: libmail-box-perl_2.110-1_all bug

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.

       See documentation in the base class.

METHODS

       See documentation in the base class.

   Constructors
       See documentation in the base class.

       $obj->clone(OPTIONS)
           See "Constructors" in Mail::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        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
       See documentation in the base class.

       $obj->bounce([RG-OBJECT|OPTIONS])
           See "Constructing a message" in Mail::Message::Construct::Bounce

       Mail::Message::Dummy->build([MESSAGE|PART|BODY], CONTENT)
           See "Constructing a message" in Mail::Message::Construct::Build

       Mail::Message::Dummy->buildFromBody(BODY, [HEAD], HEADERS)
           See "Constructing a message" in Mail::Message::Construct::Build

       $obj->forward(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardAttach(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardEncapsulate(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardInline(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardNo(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardPostlude()
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardPrelude()
           See "Constructing a message" in Mail::Message::Construct::Forward

       $obj->forwardSubject(STRING)
           See "Constructing a message" in Mail::Message::Construct::Forward

       Mail::Message::Dummy->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Read

       $obj->rebuild(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Rebuild

       $obj->reply(OPTIONS)
           See "Constructing a message" in Mail::Message::Construct::Reply

       $obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
           See "Constructing a message" in Mail::Message::Construct::Reply

       $obj->replySubject(STRING)
       Mail::Message::Dummy->replySubject(STRING)
           See "Constructing a message" in Mail::Message::Construct::Reply

   The message
       See documentation in the base class.

       $obj->container()
           See "The message" in Mail::Message

       $obj->isDummy()
           See "The message" in Mail::Message

       $obj->isPart()
           See "The message" in Mail::Message

       $obj->messageId()
           See "The message" in Mail::Message

       $obj->partNumber()
           See "The message" in Mail::Message

       $obj->print([FILEHANDLE])
           See "The message" in Mail::Message

       $obj->send([MAILER], OPTIONS)
           See "The message" in Mail::Message

       $obj->size()
           See "The message" in Mail::Message

       $obj->toplevel()
           See "The message" in Mail::Message

       $obj->write([FILEHANDLE])
           See "The message" in Mail::Message

   The header
       See documentation in the base class.

       $obj->bcc()
           See "The header" in Mail::Message

       $obj->cc()
           See "The header" in Mail::Message

       $obj->date()
           See "The header" in Mail::Message

       $obj->destinations()
           See "The header" in Mail::Message

       $obj->from()
           See "The header" in Mail::Message

       $obj->get(FIELDNAME)
           See "The header" in Mail::Message

       $obj->guessTimestamp()
           See "The header" in Mail::Message

       $obj->head(...)
       $obj->nrLines()
           See "The header" in Mail::Message

       $obj->sender()
           See "The header" in Mail::Message

       $obj->study(FIELDNAME)
           See "The header" in Mail::Message

       $obj->subject()
           See "The header" in Mail::Message

       $obj->timestamp()
           See "The header" in Mail::Message

       $obj->to()
           See "The header" in Mail::Message

   The body
       See documentation in the base class.

       $obj->body([BODY])
           See "The body" in Mail::Message

       $obj->contentType()
           See "The body" in Mail::Message

       $obj->decoded(OPTIONS)
           See "The body" in Mail::Message

       $obj->encode(OPTIONS)
           See "The body" in Mail::Message

       $obj->isMultipart()
           See "The body" in Mail::Message

       $obj->isNested()
           See "The body" in Mail::Message

       $obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
           See "The body" in Mail::Message

   Flags
       See documentation in the base class.

       $obj->delete()
           See "Flags" in Mail::Message

       $obj->deleted([BOOLEAN])
           See "Flags" in Mail::Message

       $obj->isDeleted()
           See "Flags" in Mail::Message

       $obj->isModified()
           See "Flags" in Mail::Message

       $obj->label(LABEL|PAIRS)
           See "Flags" in Mail::Message

       $obj->labels()
           See "Flags" in Mail::Message

       $obj->labelsToStatus()
           See "Flags" in Mail::Message

       $obj->modified([BOOLEAN])
           See "Flags" in Mail::Message

       $obj->statusToLabels()
           See "Flags" in Mail::Message

   The whole message as text
       See documentation in the base class.

       $obj->file()
           See "The whole message as text" in Mail::Message::Construct::Text

       $obj->lines()
           See "The whole message as text" in Mail::Message::Construct::Text

       $obj->printStructure([FILEHANDLE|undef],[INDENT])
           See "The whole message as text" in Mail::Message::Construct::Text

       $obj->string()
           See "The whole message as text" in Mail::Message::Construct::Text

   Internals
       See documentation in the base class.

       $obj->clonedFrom()
           See "Internals" in Mail::Message

       Mail::Message::Dummy->coerce(MESSAGE, OPTIONS)
           See "Internals" in Mail::Message

       $obj->isDelayed()
           See "Internals" in Mail::Message

       $obj->readBody(PARSER, HEAD [, BODYTYPE])
           See "Internals" in Mail::Message

       $obj->readFromParser(PARSER, [BODYTYPE])
           See "Internals" in Mail::Message

       $obj->readHead(PARSER [,CLASS])
           See "Internals" in Mail::Message

       $obj->recursiveRebuildPart(PART, OPTIONS)
           See "Internals" in Mail::Message::Construct::Rebuild

       $obj->storeBody(BODY)
           See "Internals" in Mail::Message

       $obj->takeMessageId([STRING])
           See "Internals" in Mail::Message

   Error handling
       See documentation in the base class.

       $obj->AUTOLOAD()
           See "METHODS" in Mail::Message::Construct

       $obj->addReport(OBJECT)
           See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
       Mail::Message::Dummy->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
           See "Error handling" in Mail::Reporter

       $obj->errors()
           See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])
       Mail::Message::Dummy->log([LEVEL [,STRINGS]])
           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Message::Dummy->logPriority(LEVEL)
           See "Error handling" in Mail::Reporter

       $obj->logSettings()
           See "Error handling" in Mail::Reporter

       $obj->notImplemented()
           See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])
           See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])
           See "Error handling" in Mail::Reporter

       $obj->shortSize([VALUE])
       Mail::Message::Dummy->shortSize([VALUE])
           See "Error handling" in Mail::Message

       $obj->shortString()
           See "Error handling" in Mail::Message

       $obj->trace([LEVEL])
           See "Error handling" in Mail::Reporter

       $obj->warnings()
           See "Error handling" in Mail::Reporter

   Cleanup
       See documentation in the base class.

       $obj->DESTROY()
           See "Cleanup" in Mail::Message

       $obj->destruct()
           See "Cleanup" in Mail::Message

DETAILS

       See documentation in the base class.

DIAGNOSTICS

       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

SEE ALSO

       This module is part of Mail-Box distribution version 2.110, built on January 05, 2014.
       Website: http://perl.overmeer.net/mailbox/

LICENSE

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