Linux Certif

Toute la documentation sur la certification Linux LPI

Mail::Box::MH::Message.3pm

NAME

Mail::Box::MH::Message - one message in an MH-folder

INHERITANCE

  Mail::Box::MH::Message
    is a Mail::Box::Dir::Message
    is a Mail::Box::Message
    is a Mail::Message
    is a Mail::Reporter
 
 

SYNOPSIS

  my $folder = new Mail::Box::MH ...
  my $message = $folder->message(10);
 
 

DESCRIPTION

A "Mail::Box::MH::Message" represents one message in an Mail::Box::MH folder . Each message is stored in a separate file, as for all Mail::Box::Dir folder types.

METHODS

Constructors

$obj->clone(OPTIONS)

See ``Constructors'' in Mail::Message

Mail::Box::MH::Message->new(OPTIONS)

See ``METHODS'' in Mail::Box::Dir::Message

Constructing a message

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

See ``Constructing a message'' in Mail::Message::Construct::Bounce

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

See ``Constructing a message'' in Mail::Message::Construct::Build

Mail::Box::MH::Message->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::Box::MH::Message->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::Box::MH::Message->replySubject(STRING)

See ``Constructing a message'' in Mail::Message::Construct::Reply

The message

$obj->container

See ``The message'' in Mail::Message

$obj->copyTo(FOLDER, OPTIONS)

See ``The message'' in Mail::Box::Message

$obj->filename([FILENAME])

See ``The message'' in Mail::Box::Dir::Message

$obj->folder([FOLDER])

See ``The message'' in Mail::Box::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->moveTo(FOLDER, OPTIONS)

See ``The message'' in Mail::Box::Message

$obj->print([FILEHANDLE])

See ``The message'' in Mail::Message

$obj->send([MAILER], OPTIONS)

See ``The message'' in Mail::Message

$obj->seqnr([INTEGER])

The order of this message in the folder, counted from zero. Do not change the number (unless you understand the implications).
WARNING: This sequence number has nothing to do with the message's filename, which in case of MH folders are also numbers! If you need that one, use the File::Basename subroutine basename of the filename.

$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

$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([HEAD])

See ``The header'' in Mail::Message

$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

$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

$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

$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

$obj->clonedFrom

See ``Internals'' in Mail::Message

Mail::Box::MH::Message->coerce(MESSAGE, OPTIONS)

See ``Internals'' in Mail::Message

$obj->create(FILENAME)

See ``Internals'' in Mail::Box::Dir::Message

$obj->diskDelete

See ``Internals'' in Mail::Box::Message

$obj->isDelayed

See ``Internals'' in Mail::Message

$obj->loadBody

See ``Internals'' in Mail::Box::Dir::Message

$obj->loadHead

See ``Internals'' in Mail::Box::Dir::Message

$obj->parser

See ``Internals'' in Mail::Box::Dir::Message

$obj->readBody(PARSER, HEAD [, BODYTYPE])

See ``Internals'' in Mail::Box::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

$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::Box::MH::Message->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::Box::MH::Message->log([LEVEL [,STRINGS]])

See ``Error handling'' in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Box::MH::Message->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::Box::MH::Message->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

$obj->DESTROY

See ``Cleanup'' in Mail::Message

$obj->destruct

See ``Cleanup'' in Mail::Box::Message

$obj->inGlobalDestruction

See ``Cleanup'' in Mail::Reporter

DETAILS

Labels

The .mh_sequences file

Typically, the file which contains the labels is called ".mh_sequences". The MH messages are numbered from 1. As example content for ".mh_sequences":

  cur: 93
  unseen: 32 35-56 67-80
 
 

To generalize labels on messages, two are treated specially:

*

cur

The "cur" specifies the number of the message where the user stopped reading mail from this folder at last access. Internally in these modules referred to as label "current".

*

unseen

With "unseen" is listed which message was never read. This must be a mistake in the design of MH: it must be a source of confusion. People should never use labels with a negation in the name:

  if($seen)           if(!$unseen)    #yuk!
  if(!$seen)          if($unseen)
  unless($seen)       unless($unseen) #yuk!
 
 

So: label "unseen" is translated into "seen" for internal use.

DIAGNOSTICS

Error: Cannot coerce a $class object into a $class object

Error: Cannot create parser for $filename.

For some reason (the previous message have told you already) it was not possible to create a message parser for the specified filename.

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: Cannot write message to $filename: $!

When a modified or new message is written to disk, it is first written to a temporary file in the folder directory. For some reason, it is impossible to create this file.

Error: Failed to move $new to $filename: $!

When a modified or new message is written to disk, it is first written to a temporary file in the folder directory. Then, the new file is moved to replace the existing file. Apparently, the latter fails.

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: Unable to read delayed body.

For some reason, the header of the message could be read, but the body cannot. Probably the file has disappeared or the permissions were changed during the progress of the program.

Error: Unable to read delayed head.

Mail::Box tries to be lazy with respect to parsing messages. When a directory organized folder is opened, only the filenames of messages are collected. At first use, the messages are read from their file. Apperently, a message is used for the first time here, but has disappeared or is unreadible for some other reason.

Error: coercion starts with some object

SEE ALSO

This module is part of Mail-Box distribution version 2.095, built on July 02, 2010. Website: http://perl.overmeer.net/mailbox/

LICENSE

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