NAME

Mail::Box::Message::Dummy - a placeholder for a missing message in a list.

CLASS HIERARCHY

Mail::Box::Message::Dummy
is a Mail::Box::Message
is a Mail::Message + ::Construct
is a Mail::Reporter

SYNOPSIS

DESCRIPTION

Read Mail::Box-Overview first.

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.

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Message (MM), Mail::Reporter (MR), Mail::Box::Message (MBM), Mail::Message::Construct (MMC).

The general methods for Mail::Box::Message::Dummy objects:

 MM bcc                               MR log [LEVEL [,STRINGS]]
MMC bounce OPTIONS                    MM messageId
MMC build [MESSAGE|BODY], CONTENT     MM modified [BOOL]
MMC buildFromBody BODY, HEADERS      MBM new OPTIONS
 MM cc                                MM nrLines
MBM copyTo FOLDER                     MM parent
 MM date                              MM parts ['ALL'|'ACTIVE'|'DELE...
 MM decoded OPTIONS                   MM print [FILEHANDLE]
MBM delete                           MMC printStructure [INDENT]
MBM deleted [BOOL]                   MMC read FILEHANDLE|SCALAR|REF-...
 MM destinations                     MMC reply OPTIONS
 MM encode OPTIONS                   MMC replyPrelude [STRING|FIELD|...
 MR errors                           MMC replySubject STRING
MMC file                              MR report [LEVEL]
MBM folder [FOLDER]                   MR reportAll [LEVEL]
MMC forward OPTIONS                   MM send [MAILER], OPTIONS
MMC forwardPostlude                  MBM seqnr [INTEGER]
MMC forwardPrelude                   MBM shortString
MMC forwardSubject STRING             MM size
 MM from                             MMC string
 MM get FIELD                         MM subject
 MM guessTimestamp                    MM timestamp
 MM isDummy                           MM to
 MM isMultipart                       MM toplevel
 MM isPart                            MR trace [LEVEL]
 MM label LABEL [,VALUE [LABEL,...    MR warnings
MMC lines

The extra methods for extension writers:

 MR AUTOLOAD                          MM labelsToStatus
 MM DESTROY                           MR logPriority LEVEL
 MM body [BODY]                       MR logSettings
 MM clone                             MR notImplemented
MBM coerce MESSAGE                   MBM readBody PARSER, HEAD [, BO...
MBM diskDelete                        MM readFromParser PARSER, [BOD...
 MM head [HEAD]                       MM readHead PARSER [,CLASS]
 MR inGlobalDestruction               MM statusToLabels
 MM isDelayed                         MM storeBody BODY
 MM labels                            MM takeMessageId [STRING]

METHOD

new MESSAGE-ID

(Class method) Create a new dummy message to occupy the space for a real message with the specified MESSAGE-ID.

Examples:

my $message = Mail::Box::Message::Dummy->new($msgid);
if($message->isDummy) {...}

SEE ALSO

Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR

Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 2.017.

Copyright (c) 2001-2002 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.