Mail::Box::MH::Message3pm
One message in an mh-folder
Usage
my $folder = new Mail::Box::MH ...my $message = $folder->message(10);
Inheritance
Mail::Box::MH::Messageis a Mail::Box::Dir::Messageis a Mail::Box::Messageis a Mail::Messageis a Mail::Reporter
Overview
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.
Extends "DESCRIPTION" in Mail::Box::Dir::Message.
Methods
Extends "METHODS" in Mail::Box::Dir::Message.
Constructors
Extends "Constructors" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "Constructors" in Mail::Message |
|---|---|
$class->
|
Inherited, see "Constructors" in Mail::Box::Dir::Message |
Attributes
Extends "Attributes" in Mail::Box::Dir::Message.
- $obj->
bodyType() -
Inherited, see "Attributes" in Mail::Message
- $obj->
fieldType() -
Inherited, see "Attributes" in Mail::Message
- $obj->
filename( [$filename] ) -
Inherited, see "Attributes" in Mail::Box::Dir::Message
- $obj->
fixHeader() -
Inherited, see "Attributes" in Mail::Box::Dir::Message
- $obj->
folder( [$folder] ) -
Inherited, see "Attributes" in Mail::Box::Message
- $obj->
headType() -
Inherited, see "Attributes" in Mail::Message
- $obj->
messageId() -
Inherited, see "Attributes" 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. Improves base, see "Attributes" in Mail::Box::Message
Constructing a message
Extends "Constructing a message" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Bounce |
|---|---|
$class->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Build |
$class->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Build |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Forward |
$class->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Read |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Rebuild |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Reply |
$obj->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Reply |
$any->
|
Inherited, see "Constructing a message" in Mail::Message::Construct::Reply |
The message
Extends "The message" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "The message" in Mail::Message |
|---|---|
$obj->
|
Inherited, see "The message" in Mail::Box::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Box::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
$obj->
|
Inherited, see "The message" in Mail::Message |
The header
Extends "The header" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "The header" in Mail::Message |
|---|---|
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
$obj->
|
Inherited, see "The header" in Mail::Message |
The body
Extends "The body" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "The body" in Mail::Message |
|---|---|
$obj->
|
Inherited, see "The body" in Mail::Message |
$obj->
|
Inherited, see "The body" in Mail::Message |
$obj->
|
Inherited, see "The body" in Mail::Message |
$obj->
|
Inherited, see "The body" in Mail::Message |
$obj->
|
Inherited, see "The body" in Mail::Message |
$obj->
|
Inherited, see "The body" in Mail::Message |
Flags
Extends "Flags" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "Flags" in Mail::Message |
|---|---|
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
$obj->
|
Inherited, see "Flags" in Mail::Message |
The whole message as text
Extends "The whole message as text" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "The whole message as text" in Mail::Message::Construct::Text |
|---|---|
$obj->
|
Inherited, see "The whole message as text" in Mail::Message::Construct::Text |
$obj->
|
Inherited, see "The whole message as text" in Mail::Message::Construct::Text |
$obj->
|
Inherited, see "The whole message as text" in Mail::Message::Construct::Text |
Internals
Extends "Internals" in Mail::Box::Dir::Message.
$obj->
|
Inherited, see "Internals" in Mail::Message |
|---|---|
$class->
|
Inherited, see "Internals" in Mail::Message |
$obj->
|
Inherited, see "Internals" in Mail::Box::Dir::Message |
$obj->
|
Inherited, see "Internals" in Mail::Box::Message |
$obj->
|
Inherited, see "Internals" in Mail::Message |
$obj->
|
Inherited, see "Internals" in Mail::Message |
$obj->
|
Inherited, see "Internals" in Mail::Box::Dir::Message |
$obj->
|
Inherited, see "Internals" in Mail::Box::Dir::Message |
$obj->
|
Inherited, see "Internals" in Mail::Box::Dir::Message |
$obj->
|
Inherited, see "Internals" in Mail::Box::Message |
$obj->
|
Inherited, see "Internals" in Mail::Message |
$obj->
|
Inherited, see "Internals" in Mail::Message |
$obj->
|
Inherited, see "Internals" in Mail::Message::Construct::Rebuild |
$obj->
|
Inherited, see "Internals" in Mail::Message |
$obj->
|
Inherited, see "Internals" in Mail::Message |
Error handling
Extends "Error handling" in Mail::Box::Dir::Message.
$obj->AUTOLOAD()
|
Inherited, see "METHODS" in Mail::Message::Construct |
|---|---|
$obj->
|
Inherited, see "Error handling" in Mail::Reporter |
$any->
|
Inherited, see "Error handling" in Mail::Message |
$obj->
|
Inherited, see "Error handling" in Mail::Message |
Cleanup
Extends "Cleanup" in Mail::Box::Dir::Message.
$obj->DESTROY()
|
Inherited, see "Cleanup" in Mail::Reporter |
|---|---|
$obj->
|
Inherited, see "Cleanup" in Mail::Box::Message |
Details
Extends "DETAILS" in Mail::Box::Dir::Message.
Structure of a Message
Extends "Structure of a Message" in Mail::Box::Dir::Message.
Message object implementation
Extends "Message object implementation" in Mail::Box::Dir::Message.
Message class implementation
Extends "Message class implementation" in Mail::Box::Dir::Message.
Labels
Extends "Labels" in Mail::Box::Dir::Message.
Predefined labels
Extends "Predefined labels" in Mail::Box::Dir::Message.
Status and X-Status fields
Extends "Status and X-Status fields" in Mail::Box::Dir::Message.
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: 93unseen: 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 include forward source as $kind.
-
Unknown alternative for the forward(include). Valid choices are
"NO","INLINE","ATTACH", and"ENCAPSULATE". Cast byforward()
- 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. Cast bysend()
- Error: cannot coerce a $type object into a $me object.
-
Cast by
coerce()
- Error: cannot include reply source as $kind.
-
Unknown alternative for the
"include"option ofreply(). Valid choices are"NO","INLINE", and"ATTACH". Cast byreply()
- Error: cannot read message from a $source.
-
Cast by
read()
- Fault: cannot write message to $file: $!
-
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. Cast by
create()
- Error: class $package does not implement method $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. Cast bynotImplemented()
- Error: coercion starts with some object, not '$type'.
-
Cast by
coerce()
- Fault: failed to rename file $from to $to: $!
-
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. Cast by
create()
- 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 forreply(). When you wish to modify the content, useforward(). Cast bybounce()
- Error: method forwardAttach requires a preamble.
-
Cast by
forwardAttach()
- Error: method forwardEncapsulate requires a preamble.
-
Cast by
forwardEncapsulate()
- Error: method forwardNo requires a To.
-
Cast by
forwardNo()
- Error: method forwardNo requires a body.
-
Cast by
forwardNo()
- Error: no rebuild rule $name defined.
-
Cast by
rebuild()
- 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 getcoerce()-d into the right message type, adding storage information and the like. Cast bybuild()
- Error: please install Email::Simple.
-
Cast by
coerce()
- Error: please install MIME::Entity.
-
Cast by
coerce()
- Error: please install Mail::Internet.
-
Cast by
coerce()
- Error: select parts via '$what'?
-
Cast by
parts()
- Warning: skipped unknown key '$key' in build.
-
Cast by
build()
- Error: unable to read delayed body for message $msgid.
-
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. Cast by
loadBody()
- Error: unable to read delayed head for message $msgid.
-
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. Cast by
loadBody()
Releases
13 releases since Debian 3.0 (Woody); the text changed 11 times.