GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::DUMMY (3)

.ds Aq ’

NAME

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

CONTENTS

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-><B>cloneB>(OPTIONS) See Constructors in Mail::Message
Mail::Message::Dummy-><B>newB>(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-><B>bounceB>([RG-OBJECT|OPTIONS]) See Constructing a message in Mail::Message::Construct::Bounce
Mail::Message::Dummy-><B>buildB>([MESSAGE|PART|BODY], CONTENT) See Constructing a message in Mail::Message::Construct::Build
Mail::Message::Dummy-><B>buildFromBodyB>(BODY, [HEAD], HEADERS) See Constructing a message in Mail::Message::Construct::Build
$obj-><B>forwardB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardAttachB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardEncapsulateB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardInlineB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardNoB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardPostludeB>() See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardPreludeB>() See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardSubjectB>(STRING) See Constructing a message in Mail::Message::Construct::Forward
Mail::Message::Dummy-><B>readB>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS) See Constructing a message in Mail::Message::Construct::Read
$obj-><B>rebuildB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Rebuild
$obj-><B>replyB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Reply
$obj-><B>replyPreludeB>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS]) See Constructing a message in Mail::Message::Construct::Reply
$obj-><B>replySubjectB>(STRING)
Mail::Message::Dummy-><B>replySubjectB>(STRING) See Constructing a message in Mail::Message::Construct::Reply

    The message

See documentation in the base class.
$obj-><B>containerB>() See The message in Mail::Message
$obj-><B>isDummyB>() See The message in Mail::Message
$obj-><B>isPartB>() See The message in Mail::Message
$obj-><B>messageIdB>() See The message in Mail::Message
$obj-><B>partNumberB>() See The message in Mail::Message
$obj-><B>printB>([FILEHANDLE]) See The message in Mail::Message
$obj-><B>sendB>([MAILER], OPTIONS) See The message in Mail::Message
$obj-><B>sizeB>() See The message in Mail::Message
$obj-><B>toplevelB>() See The message in Mail::Message
$obj-><B>writeB>([FILEHANDLE]) See The message in Mail::Message

    The header

See documentation in the base class.
$obj-><B>bccB>() See The header in Mail::Message
$obj-><B>ccB>() See The header in Mail::Message
$obj-><B>dateB>() See The header in Mail::Message
$obj-><B>destinationsB>() See The header in Mail::Message
$obj-><B>fromB>() See The header in Mail::Message
$obj-><B>getB>(FIELDNAME) See The header in Mail::Message
$obj-><B>guessTimestampB>() See The header in Mail::Message
$obj-><B>headB>(...)
$obj-><B>nrLinesB>() See The header in Mail::Message
$obj-><B>senderB>() See The header in Mail::Message
$obj-><B>studyB>(FIELDNAME) See The header in Mail::Message
$obj-><B>subjectB>() See The header in Mail::Message
$obj-><B>timestampB>() See The header in Mail::Message
$obj-><B>toB>() See The header in Mail::Message

    The body

See documentation in the base class.
$obj-><B>bodyB>([BODY]) See The body in Mail::Message
$obj-><B>contentTypeB>() See The body in Mail::Message
$obj-><B>decodedB>(OPTIONS) See The body in Mail::Message
$obj-><B>encodeB>(OPTIONS) See The body in Mail::Message
$obj-><B>isMultipartB>() See The body in Mail::Message
$obj-><B>isNestedB>() See The body in Mail::Message
$obj-><B>partsB>([’ALL’|’ACTIVE’|’DELETED’|’RECURSE’|FILTER]) See The body in Mail::Message

    Flags

See documentation in the base class.
$obj-><B>deleteB>() See Flags in Mail::Message
$obj-><B>deletedB>([BOOLEAN]) See Flags in Mail::Message
$obj-><B>isDeletedB>() See Flags in Mail::Message
$obj-><B>isModifiedB>() See Flags in Mail::Message
$obj-><B>labelB>(LABEL|PAIRS) See Flags in Mail::Message
$obj-><B>labelsB>() See Flags in Mail::Message
$obj-><B>labelsToStatusB>() See Flags in Mail::Message
$obj-><B>modifiedB>([BOOLEAN]) See Flags in Mail::Message
$obj-><B>statusToLabelsB>() See Flags in Mail::Message

    The whole message as text

See documentation in the base class.
$obj-><B>fileB>() See The whole message as text in Mail::Message::Construct::Text
$obj-><B>linesB>() See The whole message as text in Mail::Message::Construct::Text
$obj-><B>printStructureB>([FILEHANDLE|undef],[INDENT]) See The whole message as text in Mail::Message::Construct::Text
$obj-><B>stringB>() See The whole message as text in Mail::Message::Construct::Text

    Internals

See documentation in the base class.
$obj-><B>clonedFromB>() See Internals in Mail::Message
Mail::Message::Dummy-><B>coerceB>(MESSAGE, OPTIONS) See Internals in Mail::Message
$obj-><B>isDelayedB>() See Internals in Mail::Message
$obj-><B>readBodyB>(PARSER, HEAD [, BODYTYPE]) See Internals in Mail::Message
$obj-><B>readFromParserB>(PARSER, [BODYTYPE]) See Internals in Mail::Message
$obj-><B>readHeadB>(PARSER [,CLASS]) See Internals in Mail::Message
$obj-><B>recursiveRebuildPartB>(PART, OPTIONS) See Internals in Mail::Message::Construct::Rebuild
$obj-><B>storeBodyB>(BODY) See Internals in Mail::Message
$obj-><B>takeMessageIdB>([STRING]) See Internals in Mail::Message

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See METHODS in Mail::Message::Construct
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Dummy-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Dummy-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Dummy-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>shortSizeB>([VALUE])
Mail::Message::Dummy-><B>shortSizeB>([VALUE]) See Error handling in Mail::Message
$obj-><B>shortStringB>() See Error handling in Mail::Message
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Message
$obj-><B>destructB>() 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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::DUMMY (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.