• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• METHODS
  • Constructors
  • Constructing a message
  • The message
  • The header
  • The body
  • Flags
  • The whole message as text
  • Internals
  • Error handling
  • Cleanup
• DETAILS
  • Labels
• DIAGNOSTICS
• SEE ALSO
• LICENSE

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 Mail::Message/"Constructors"

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

See Mail::Box::Dir::Message/"METHODS"

Constructing a message

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

See Mail::Message::Construct::Bounce/"Constructing a message"

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

See Mail::Message::Construct::Build/"Constructing a message"

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

See Mail::Message::Construct::Build/"Constructing a message"

$obj->forward(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardAttach(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardEncapsulate(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardInline(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardNo(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardPostlude

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardPrelude

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardSubject(STRING)

See Mail::Message::Construct::Forward/"Constructing a message"

Mail::Box::MH::Message->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)

See Mail::Message::Construct::Read/"Constructing a message"

$obj->rebuild(OPTIONS)

See Mail::Message::Construct::Rebuild/"Constructing a message"

$obj->reply(OPTIONS)

See Mail::Message::Construct::Reply/"Constructing a message"

$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])

See Mail::Message::Construct::Reply/"Constructing a message"

$obj->replySubject(STRING)

Mail::Box::MH::Message->replySubject(STRING)

See Mail::Message::Construct::Reply/"Constructing a message"

The message

$obj->container

See Mail::Message/"The message"

$obj->copyTo(FOLDER, OPTIONS)

See Mail::Box::Message/"The message"

$obj->filename([FILENAME])

See Mail::Box::Dir::Message/"The message"

$obj->folder([FOLDER])

See Mail::Box::Message/"The message"

$obj->isDummy

See Mail::Message/"The message"

$obj->isPart

See Mail::Message/"The message"

$obj->messageId

See Mail::Message/"The message"

$obj->moveTo(FOLDER, OPTIONS)

See Mail::Box::Message/"The message"

$obj->print([FILEHANDLE])

See Mail::Message/"The message"

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

See Mail::Message/"The 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 Mail::Message/"The message"

$obj->toplevel

See Mail::Message/"The message"

$obj->write([FILEHANDLE])

See Mail::Message/"The message"

The header

$obj->bcc

See Mail::Message/"The header"

$obj->cc

See Mail::Message/"The header"

$obj->date

See Mail::Message/"The header"

$obj->destinations

See Mail::Message/"The header"

$obj->from

See Mail::Message/"The header"

$obj->get(FIELDNAME)

See Mail::Message/"The header"

$obj->guessTimestamp

See Mail::Message/"The header"

$obj->head([HEAD])

See Mail::Message/"The header"

$obj->nrLines

See Mail::Message/"The header"

$obj->sender

See Mail::Message/"The header"

$obj->study(FIELDNAME)

See Mail::Message/"The header"

$obj->subject

See Mail::Message/"The header"

$obj->timestamp

See Mail::Message/"The header"

$obj->to

See Mail::Message/"The header"

The body

$obj->body([BODY])

See Mail::Message/"The body"

$obj->contentType

See Mail::Message/"The body"

$obj->decoded(OPTIONS)

See Mail::Message/"The body"

$obj->encode(OPTIONS)

See Mail::Message/"The body"

$obj->isMultipart

See Mail::Message/"The body"

$obj->isNested

See Mail::Message/"The body"

$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])

See Mail::Message/"The body"

Flags

$obj->delete

See Mail::Message/"Flags"

$obj->deleted([BOOLEAN])

See Mail::Message/"Flags"

$obj->isDeleted

See Mail::Message/"Flags"

$obj->isModified

See Mail::Message/"Flags"

$obj->label(LABEL|PAIRS)

See Mail::Message/"Flags"

$obj->labels

See Mail::Message/"Flags"

$obj->labelsToStatus

See Mail::Message/"Flags"

$obj->modified([BOOLEAN])

See Mail::Message/"Flags"

$obj->statusToLabels

See Mail::Message/"Flags"

The whole message as text

$obj->file

See Mail::Message::Construct::Text/"The whole message as text"

$obj->lines

See Mail::Message::Construct::Text/"The whole message as text"

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

See Mail::Message::Construct::Text/"The whole message as text"

$obj->string

See Mail::Message::Construct::Text/"The whole message as text"

Internals

$obj->clonedFrom

See Mail::Message/"Internals"

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

See Mail::Message/"Internals"

$obj->create(FILENAME)

See Mail::Box::Dir::Message/"Internals"

$obj->diskDelete

See Mail::Box::Message/"Internals"

$obj->isDelayed

See Mail::Message/"Internals"

$obj->loadBody

See Mail::Box::Dir::Message/"Internals"

$obj->loadHead

See Mail::Box::Dir::Message/"Internals"

$obj->parser

See Mail::Box::Dir::Message/"Internals"

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

See Mail::Box::Message/"Internals"

$obj->readFromParser(PARSER, [BODYTYPE])

See Mail::Message/"Internals"

$obj->readHead(PARSER [,CLASS])

See Mail::Message/"Internals"

$obj->recursiveRebuildPart(PART, OPTIONS)

See Mail::Message::Construct::Rebuild/"Internals"

$obj->storeBody(BODY)

See Mail::Message/"Internals"

$obj->takeMessageId([STRING])

See Mail::Message/"Internals"

Error handling

$obj->AUTOLOAD

See Mail::Message::Construct/"METHODS"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

$obj->log([LEVEL [,STRINGS]])

Mail::Box::MH::Message->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Box::MH::Message->logPriority(LEVEL)

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->shortSize([VALUE])

Mail::Box::MH::Message->shortSize([VALUE])

See Mail::Message/"Error handling"

$obj->shortString

See Mail::Message/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Message/"Cleanup"

$obj->destruct

See Mail::Box::Message/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

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.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE

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