Mail::Box::MH::Message(3)                  User Contributed Perl Documentation


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.

       Extends "DESCRIPTION" in Mail::Box::Dir::Message.

METHODS
       Extends "METHODS" in Mail::Box::Dir::Message.

   Constructors
       Extends "Constructors" in Mail::Box::Dir::Message.

       $obj->clone(%options)
           Inherited, see "Constructors" in Mail::Message

       $class->new(%options)
           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->bounce( [<$rg_object|%options>] )
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Bounce

       $class->build( [$message|$part|$body], @fields, %options )
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Build

       $class->buildFromBody($body, [$head], $headers)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Build

       $obj->forward(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardAttach(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardEncapsulate(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardInline(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardNo(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardPostlude()
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardPrelude()
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $obj->forwardSubject(STRING)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Forward

       $class->read($fh|$text|\$text|\@lines, %options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Read

       $obj->rebuild(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Rebuild

       $obj->reply(%options)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Reply

       $obj->replyPrelude( [STRING|$field|$address|\@addrs|\@fields] )
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Reply

       $any->replySubject(STRING)
           Inherited, see "Constructing a message" in
           Mail::Message::Construct::Reply

   The message
       Extends "The message" in Mail::Box::Dir::Message.

       $obj->container()
           Inherited, see "The message" in Mail::Message

       $obj->copyTo($folder, %options)
           Inherited, see "The message" in Mail::Box::Message

       $obj->endsOnNewline()
           Inherited, see "The message" in Mail::Message

       $obj->isDummy()
           Inherited, see "The message" in Mail::Message

       $obj->isPart()
           Inherited, see "The message" in Mail::Message

       $obj->moveTo($folder, %options)
           Inherited, see "The message" in Mail::Box::Message

       $obj->partNumber()
           Inherited, see "The message" in Mail::Message

       $obj->print( [$fh] )
           Inherited, see "The message" in Mail::Message

       $obj->send( [$mailer], %options )
           Inherited, see "The message" in Mail::Message

       $obj->size()
           Inherited, see "The message" in Mail::Message

       $obj->toplevel()
           Inherited, see "The message" in Mail::Message

       $obj->write( [$fh] )
           Inherited, see "The message" in Mail::Message

   The header
       Extends "The header" in Mail::Box::Dir::Message.

       $obj->bcc()
           Inherited, see "The header" in Mail::Message

       $obj->cc()
           Inherited, see "The header" in Mail::Message

       $obj->date()
           Inherited, see "The header" in Mail::Message

       $obj->destinations()
           Inherited, see "The header" in Mail::Message

       $obj->from()
           Inherited, see "The header" in Mail::Message

       $obj->get($fieldname)
           Inherited, see "The header" in Mail::Message

       $obj->guessTimestamp()
           Inherited, see "The header" in Mail::Message

       $obj->head( [$head] )
           Inherited, see "The header" in Mail::Message

       $obj->nrLines()
           Inherited, see "The header" in Mail::Message

       $obj->sender()
           Inherited, see "The header" in Mail::Message

       $obj->study($fieldname)
           Inherited, see "The header" in Mail::Message

       $obj->subject()
           Inherited, see "The header" in Mail::Message

       $obj->timestamp()
           Inherited, see "The header" in Mail::Message

       $obj->to()
           Inherited, see "The header" in Mail::Message

   The body
       Extends "The body" in Mail::Box::Dir::Message.

       $obj->body( [$body] )
           Inherited, see "The body" in Mail::Message

       $obj->contentType()
           Inherited, see "The body" in Mail::Message

       $obj->decoded(%options)
           Inherited, see "The body" in Mail::Message

       $obj->encode(%options)
           Inherited, see "The body" in Mail::Message

       $obj->isMultipart()
           Inherited, see "The body" in Mail::Message

       $obj->isNested()
           Inherited, see "The body" in Mail::Message

       $obj->parts( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
           Inherited, see "The body" in Mail::Message

   Flags
       Extends "Flags" in Mail::Box::Dir::Message.

       $obj->delete()
           Inherited, see "Flags" in Mail::Message

       $obj->deleted( [BOOLEAN] )
           Inherited, see "Flags" in Mail::Message

       $obj->isDeleted()
           Inherited, see "Flags" in Mail::Message

       $obj->isModified()
           Inherited, see "Flags" in Mail::Message

       $obj->label($label|PAIRS)
           Inherited, see "Flags" in Mail::Message

       $obj->labels()
           Inherited, see "Flags" in Mail::Message

       $obj->labelsToStatus()
           Inherited, see "Flags" in Mail::Message

       $obj->modified( [BOOLEAN] )
           Inherited, see "Flags" in Mail::Message

       $obj->statusToLabels()
           Inherited, see "Flags" in Mail::Message

   The whole message as text
       Extends "The whole message as text" in Mail::Box::Dir::Message.

       $obj->file()
           Inherited, see "The whole message as text" in
           Mail::Message::Construct::Text

       $obj->lines()
           Inherited, see "The whole message as text" in
           Mail::Message::Construct::Text

       $obj->printStructure( [$fh|undef],[$indent] )
           Inherited, see "The whole message as text" in
           Mail::Message::Construct::Text

       $obj->string()
           Inherited, see "The whole message as text" in
           Mail::Message::Construct::Text

   Internals
       Extends "Internals" in Mail::Box::Dir::Message.

       $obj->clonedFrom()
           Inherited, see "Internals" in Mail::Message

       $class->coerce($message, %options)
           Inherited, see "Internals" in Mail::Message

       $obj->create($filename)
           Inherited, see "Internals" in Mail::Box::Dir::Message

       $obj->diskDelete()
           Inherited, see "Internals" in Mail::Box::Message

       $obj->isDelayed()
           Inherited, see "Internals" in Mail::Message

       $obj->isTrusted()
           Inherited, see "Internals" in Mail::Message

       $obj->loadBody()
           Inherited, see "Internals" in Mail::Box::Dir::Message

       $obj->loadHead()
           Inherited, see "Internals" in Mail::Box::Dir::Message

       $obj->parser()
           Inherited, see "Internals" in Mail::Box::Dir::Message

       $obj->readBody( $parser, $head, [$bodytype] )
           Inherited, see "Internals" in Mail::Box::Message

       $obj->readFromParser( $parser, [$bodytype] )
           Inherited, see "Internals" in Mail::Message

       $obj->readHead( $parser, [$class] )
           Inherited, see "Internals" in Mail::Message

       $obj->recursiveRebuildPart($part, %options)
           Inherited, see "Internals" in Mail::Message::Construct::Rebuild

       $obj->storeBody($body)
           Inherited, see "Internals" in Mail::Message

       $obj->takeMessageId( [STRING] )
           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->notImplemented()
           Inherited, see "Error handling" in Mail::Reporter

       $any->shortSize( [$value] )
           Inherited, see "Error handling" in Mail::Message

       $obj->shortString()
           Inherited, see "Error handling" in Mail::Message

   Cleanup
       Extends "Cleanup" in Mail::Box::Dir::Message.

       $obj->DESTROY()
           Inherited, see "Cleanup" in Mail::Reporter

       $obj->destruct()
           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: 93
         unseen: 32 35-56 67-80

       To generalize labels on messages, two are treated specially:

       o   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".

       o   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 by forward()

       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 by
           send()

       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 of reply().  Valid
           choices are "NO", "INLINE", and "ATTACH".  Cast by reply()

       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 by
           notImplemented()

       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 for reply(). When you wish to modify the
           content, use forward().  Cast by bounce()

       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 get coerce()-d
           into the right message type, adding storage information and the
           like.  Cast by build()

       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()

SEE ALSO
       This module is part of Mail-Box version 4.02, built on April 10, 2026.
       Website: http://perl.overmeer.net/CPAN/

LICENSE
       For contributors see file ChangeLog.

       This software is copyright (c) 2001-2026 by Mark Overmeer.

       This is free software; you can redistribute it and/or modify it under
       the same terms as the Perl 5 programming language system itself.

perl v5.42.2                      2026-04-11         Mail::Box::MH::Message(3)