=head1 NAME
Mail::Box::MH::Message - one message in an MH-folder
=head1 INHERITANCE
Mail::Box::MH::Message
is a Mail::Box::Dir::Message
is a Mail::Box::Message
is a Mail::Message
is a Mail::Reporter
=head1 SYNOPSIS
my $folder = new Mail::Box::MH ...
my $message = $folder->message(10);
=head1 DESCRIPTION
A C<Mail::Box::MH::Message> represents one message in an
L<Mail::Box::MH|Mail::Box::MH> folder . Each message is stored in a separate file,
as for all L<Mail::Box::Dir|Mail::Box::Dir> folder types.
=head1 METHODS
=head2 Constructors
$obj-E<gt>B<clone>(OPTIONS)
=over 4
See L<Mail::Message/"Constructors">
=back
Mail::Box::MH::Message-E<gt>B<new>(OPTIONS)
=over 4
See L<Mail::Box::Dir::Message/"METHODS">
=back
=head2 Constructing a message
$obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
=over 4
See L<Mail::Message::Construct::Bounce/"Constructing a message">
=back
Mail::Box::MH::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
=over 4
See L<Mail::Message::Construct::Build/"Constructing a message">
=back
Mail::Box::MH::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
=over 4
See L<Mail::Message::Construct::Build/"Constructing a message">
=back
$obj-E<gt>B<forward>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardAttach>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardEncapsulate>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardInline>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardNo>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardPostlude>
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardPrelude>
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
$obj-E<gt>B<forwardSubject>(STRING)
=over 4
See L<Mail::Message::Construct::Forward/"Constructing a message">
=back
Mail::Box::MH::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
=over 4
See L<Mail::Message::Construct::Read/"Constructing a message">
=back
$obj-E<gt>B<rebuild>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Rebuild/"Constructing a message">
=back
$obj-E<gt>B<reply>(OPTIONS)
=over 4
See L<Mail::Message::Construct::Reply/"Constructing a message">
=back
$obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
=over 4
See L<Mail::Message::Construct::Reply/"Constructing a message">
=back
$obj-E<gt>B<replySubject>(STRING)
Mail::Box::MH::Message-E<gt>B<replySubject>(STRING)
=over 4
See L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
$obj-E<gt>B<container>
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
=over 4
See L<Mail::Box::Message/"The message">
=back
$obj-E<gt>B<filename>([FILENAME])
=over 4
See L<Mail::Box::Dir::Message/"The message">
=back
$obj-E<gt>B<folder>([FOLDER])
=over 4
See L<Mail::Box::Message/"The message">
=back
$obj-E<gt>B<isDummy>
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<isPart>
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<messageId>
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
=over 4
See L<Mail::Box::Message/"The message">
=back
$obj-E<gt>B<print>([FILEHANDLE])
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<send>([MAILER], OPTIONS)
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<seqnr>([INTEGER])
=over 4
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.
=back
$obj-E<gt>B<size>
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<toplevel>
=over 4
See L<Mail::Message/"The message">
=back
$obj-E<gt>B<write>([FILEHANDLE])
=over 4
See L<Mail::Message/"The message">
=back
=head2 The header
$obj-E<gt>B<bcc>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<cc>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<date>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<destinations>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<from>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<get>(FIELDNAME)
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<guessTimestamp>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<head>([HEAD])
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<nrLines>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<sender>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<study>(FIELDNAME)
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<subject>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<timestamp>
=over 4
See L<Mail::Message/"The header">
=back
$obj-E<gt>B<to>
=over 4
See L<Mail::Message/"The header">
=back
=head2 The body
$obj-E<gt>B<body>([BODY])
=over 4
See L<Mail::Message/"The body">
=back
$obj-E<gt>B<contentType>
=over 4
See L<Mail::Message/"The body">
=back
$obj-E<gt>B<decoded>(OPTIONS)
=over 4
See L<Mail::Message/"The body">
=back
$obj-E<gt>B<encode>(OPTIONS)
=over 4
See L<Mail::Message/"The body">
=back
$obj-E<gt>B<isMultipart>
=over 4
See L<Mail::Message/"The body">
=back
$obj-E<gt>B<isNested>
=over 4
See L<Mail::Message/"The body">
=back
$obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
=over 4
See L<Mail::Message/"The body">
=back
=head2 Flags
$obj-E<gt>B<delete>
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<deleted>([BOOLEAN])
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<isDeleted>
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<isModified>
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<label>(LABEL|PAIRS)
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<labels>
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<labelsToStatus>
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<modified>([BOOLEAN])
=over 4
See L<Mail::Message/"Flags">
=back
$obj-E<gt>B<statusToLabels>
=over 4
See L<Mail::Message/"Flags">
=back
=head2 The whole message as text
$obj-E<gt>B<file>
=over 4
See L<Mail::Message::Construct::Text/"The whole message as text">
=back
$obj-E<gt>B<lines>
=over 4
See L<Mail::Message::Construct::Text/"The whole message as text">
=back
$obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
=over 4
See L<Mail::Message::Construct::Text/"The whole message as text">
=back
$obj-E<gt>B<string>
=over 4
See L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
$obj-E<gt>B<clonedFrom>
=over 4
See L<Mail::Message/"Internals">
=back
Mail::Box::MH::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
=over 4
See L<Mail::Message/"Internals">
=back
$obj-E<gt>B<create>(FILENAME)
=over 4
See L<Mail::Box::Dir::Message/"Internals">
=back
$obj-E<gt>B<diskDelete>
=over 4
See L<Mail::Box::Message/"Internals">
=back
$obj-E<gt>B<isDelayed>
=over 4
See L<Mail::Message/"Internals">
=back
$obj-E<gt>B<loadBody>
=over 4
See L<Mail::Box::Dir::Message/"Internals">
=back
$obj-E<gt>B<loadHead>
=over 4
See L<Mail::Box::Dir::Message/"Internals">
=back
$obj-E<gt>B<parser>
=over 4
See L<Mail::Box::Dir::Message/"Internals">
=back
$obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
=over 4
See L<Mail::Box::Message/"Internals">
=back
$obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
=over 4
See L<Mail::Message/"Internals">
=back
$obj-E<gt>B<readHead>(PARSER [,CLASS])
=over 4
See L<Mail::Message/"Internals">
=back
$obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
=over 4
See L<Mail::Message::Construct::Rebuild/"Internals">
=back
$obj-E<gt>B<storeBody>(BODY)
=over 4
See L<Mail::Message/"Internals">
=back
$obj-E<gt>B<takeMessageId>([STRING])
=over 4
See L<Mail::Message/"Internals">
=back
=head2 Error handling
$obj-E<gt>B<AUTOLOAD>
=over 4
See L<Mail::Message::Construct/"METHODS">
=back
$obj-E<gt>B<addReport>(OBJECT)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::MH::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<errors>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<log>([LEVEL [,STRINGS]])
Mail::Box::MH::Message-E<gt>B<log>([LEVEL [,STRINGS]])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logPriority>(LEVEL)
Mail::Box::MH::Message-E<gt>B<logPriority>(LEVEL)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logSettings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<notImplemented>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<report>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<reportAll>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<shortSize>([VALUE])
Mail::Box::MH::Message-E<gt>B<shortSize>([VALUE])
=over 4
See L<Mail::Message/"Error handling">
=back
$obj-E<gt>B<shortString>
=over 4
See L<Mail::Message/"Error handling">
=back
$obj-E<gt>B<trace>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<warnings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
$obj-E<gt>B<DESTROY>
=over 4
See L<Mail::Message/"Cleanup">
=back
$obj-E<gt>B<destruct>
=over 4
See L<Mail::Box::Message/"Cleanup">
=back
$obj-E<gt>B<inGlobalDestruction>
=over 4
See L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
=head2 Labels
=head3 The .mh_sequences file
Typically, the file which contains the labels is called C<.mh_sequences>.
The MH messages are numbered from C<1>. As example content for
C<.mh_sequences>:
cur: 93
unseen: 32 35-56 67-80
To generalize labels on messages, two are treated specially:
=over 4
=item * cur
The C<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 C<current>.
=item * unseen
With C<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 C<unseen> is translated into C<seen> for internal use.
=back
=head1 DIAGNOSTICS
Error: Cannot coerce a $class object into a $class object
=over 4
=back
Error: Cannot create parser for $filename.
=over 4
For some reason (the previous message have told you already) it was not possible
to create a message parser for the specified filename.
=back
Error: Cannot include forward source as $include.
=over 4
Unknown alternative for the L<forward(include)|Mail::Message::Construct::Forward/"Constructing a message">. Valid choices are
C<NO>, C<INLINE>, C<ATTACH>, and C<ENCAPSULATE>.
=back
Error: Cannot include reply source as $include.
=over 4
Unknown alternative for the C<include> option of L<reply()|Mail::Message::Construct::Reply/"Constructing a message">. Valid
choices are C<NO>, C<INLINE>, and C<ATTACH>.
=back
Error: Cannot write message to $filename: $!
=over 4
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.
=back
Error: Failed to move $new to $filename: $!
=over 4
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.
=back
Error: Method bounce requires To, Cc, or Bcc
=over 4
The message L<bounce()|Mail::Message::Construct::Bounce/"Constructing a message"> 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 L<reply()|Mail::Message::Construct::Reply/"Constructing a message">. When you wish to modify the content, use
L<forward()|Mail::Message::Construct::Forward/"Constructing a message">.
=back
Error: Method forwardAttach requires a preamble
=over 4
=back
Error: Method forwardEncapsulate requires a preamble
=over 4
=back
Error: No address to create forwarded to.
=over 4
If a forward message is created, a destination address must be specified.
=back
Error: No default mailer found to send message.
=over 4
The message L<send()|Mail::Message/"The message"> mechanism had not enough information to automatically
find a mail transfer agent to sent this message. Specify a mailer
explicitly using the C<via> options.
=back
Error: No rebuild rule $name defined.
=over 4
=back
Error: Only build() Mail::Message's; they are not in a folder yet
=over 4
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 L<Mail::Message|Mail::Message>, and then add it to the folder. During this
L<Mail::Box::addMessage()|Mail::Box/"The folder"> process, the message will get L<coerce()|Mail::Message/"Internals">-d
into the right message type, adding storage information and the like.
=back
Error: Package $package does not implement $method.
=over 4
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.
=back
Error: Unable to read delayed body.
=over 4
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.
=back
Error: Unable to read delayed head.
=over 4
Mail::Box tries to be I<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.
=back
Error: coercion starts with some object
=over 4
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.079,
built on November 28, 2007. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2007 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 F<http://www.perl.com/perl/misc/Artistic.html>
syntax highlighted by Code2HTML, v. 0.9.1