Mail::...Message(3pm)

📦
version 4.02 · 9 versions
, in ubuntu stonking

💌 Mail::Box::Dir::Message 💌

okay bestie, so this is a page from the User Contributed Perl Documentation — yes, the Mail::...Message(3pm) situation — and it's all about Mail::Box::Dir::Message. Tea time. ☕✨

🌸 NAME 🌸

Mail::Box::Dir::Message — literally just one message, sitting in a folder that's organized as a directory.

🦋 INHERITANCE 🦋

the family tree, no cap 🌳

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

Mail::Box::Dir::Message is extended by
  Mail::Box::MH::Message
  Mail::Box::Maildir::Message

so it is a Mail::Box::Message, which is a Mail::Message, which is a Mail::Reporter. generational slay. 👑

✨ SYNOPSIS ✨

the vibe check, in code form:

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

grab a folder, ask it for message number ten, boom. that's the whole plot. 💅

💖 DESCRIPTION 💖

Mail::Box::Dir::Message is the base class for one message inside a folder that's organized as a directory — which means each message gets its own separate file. one file per message, we love a system with boundaries. 🎀

heads up, bestie: there are no objects of type Mail::Box::Dir::Message. like, none. zero. it's abstract, okay? only the extensions are allowed to actually be created. it's giving "template, not a personality." 😭

so at the moment, three of these extended message types are actually implemented:

  • Mail::Box::MH::Message — represents one message in a Mail::Box::MH folder. MH folders are *very, very simple*… which is honestly why they're not sophisticated and also not fast. no shade, just facts. 💀
  • Mail::Box::Maildir::Message — represents one message in a Mail::Box::Maildir folder. the flags are kept right there in the message's filename. and it's stateless, so you will never lose a message. not me being emotionally attached to a storage format 🥹✨
  • Mail::Box::Netzwert::Message — represents one message in a Mail::Box::Netzwert folder. the advantage? it stores pre-parsed information in the message file. the disadvantage? the code is not GPLed (yet). 💀

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

…more parts incoming, don't go anywhere bestie 🫶

✨ METHODS ✨

Extends "METHODS" in Mail::Box::Message. So yeah bestie, everything from the parent is in here too, plus the new stuff. 🫶

🏗️ Constructors 🏗️

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

  • $obj->clone(%options) — inherited, see "Constructors" in Mail::Message. 💅
  • $class->new(%options) — makes you a message, in a directory-organized folder. It improves on the base version, so go peep "Constructors" in Mail::Reporter too.

Here's the whole option roster, no skips, no gatekeeping:

  • body — defined in Mail::Message, defaults to undef 🌸
  • body_type — defined in Mail::Box::Message, defaults to <from folder> ✨
  • deleted — defined in Mail::Message, defaults to false 💀
  • field_type — defined in Mail::Message, defaults to undef 🦋
  • filename — defaults to undef 🎀
  • fix_header — defaults to false 🙈
  • folder — defined in Mail::Box::Message, required (it's giving non-negotiable, bestie) 👑
  • head — defined in Mail::Message, defaults to undef ⭐
  • head_type — defined in Mail::Message, defaults to Mail::Message::Head::Complete 🌈
  • labels — defined in Mail::Message, defaults to +{} 🍓
  • messageId — defined in Mail::Message, defaults to undef 🧚
  • message_id — defined in Mail::Message, defaults to undef 💜
  • modified — defined in Mail::Message, defaults to false 🫶
  • size — defined in Mail::Box::Message, defaults to undef ✨
  • trusted — defined in Mail::Message, defaults to false 🔥

And now each one of those, in detail:

  • body => $object — the body, obviously, it's right there in the name. 😭
  • body_type => CODE|$class — how you want the body typed up.
  • deleted => BOOLEAN — is it deleted? Yes or no, boo.
  • field_type => $class — the class handling fields.
  • filename => $file — the $file where the message is stored in. 📁
  • fix_header => BOOLEAN — see Mail::Box::new(fix_headers).
  • folder => $folder — the folder. The whole point. ✨
  • head => $object — the head object.
  • head_type => $class — which class the head should be.
  • labels => \@pairs|\%settings — labels, as pairs or settings.
  • messageId => $id — the message id.
  • message_id => $id — also the message id. Not me writing it twice, that's just genuinely what it says. 💀
  • modified => BOOLEAN — touched or untouched.
  • size => $bytes — size in bytes, periodt.
  • trusted => BOOLEAN — do we trust it or nah.

🔍 Attributes 🔍

Extends "Attributes" in Mail::Box::Message.

  • $obj->bodyType() — inherited, see "Attributes" in Mail::Message.
  • $obj->fieldType() — inherited, see "Attributes" in Mail::Message.
  • $obj->filename( [$filename] ) — hands you the name of the file where this message is actually stored. And it returns undef when the message isn't stored in a file at all. The way that is so honest of it. 🫶
  • $obj->fixHeader() — returns true when the folder is in fixing mode. ✨
  • $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] ) — inherited, see "Attributes" in Mail::Box::Message.

💌 Constructing a message 💌

Extends "Constructing a message" in Mail::Box::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::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::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::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::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::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::Message.

  • $obj->clonedFrom() — inherited, see "Internals" in Mail::Message.
  • $class->coerce($message, %options) — inherited, see "Internals" in Mail::Message.
  • $obj->create($filename) — creates the message in the file you point at. Okay so real talk: if the message already has a filename and it's not modified, then a move is attempted. Otherwise the message gets printed to the file. And if the $filename already exists for this message, literally nothing happens — nothing is done. In any case, the new $filename gets set as well. That's the whole deal. ✨
  • $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() — the autoloader calls this when the body of the message is needed. Main character timing. 💅
  • $obj->loadHead() — the autoloader calls this when the header of the message is needed. 🫶
  • $obj->parser() — creates a parser for this message and returns it (-file). 🔥
  • $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::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::Message.

  • $obj->DESTROY() — inherited, see "Cleanup" in Mail::Reporter.
  • $obj->destruct() — inherited, see "Cleanup" in Mail::Box::Message.

🌈 DETAILS 🌈

Extends "DETAILS" in Mail::Box::Message.

🩺 DIAGNOSTICS 🩺

okay bestie, these are the error messages this module throws at you when something goes sideways 💀. Each one has a cast location so you know who ratted you out ✨

  • Error: Cannot include forward source as $kind. — you passed a forward include alternative that is simply not a thing 🙈. The valid choices are "NO", "INLINE", "ATTACH", and "ENCAPSULATE". Cast by forward() 💅
  • Error: No default mailer found to send message. — the send() machinery looked around and just did not have enough info to auto-find a mail transfer agent for this message 😭. So specify a mailer explicitly with 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. — you gave the include option of reply() an alternative nobody knows ✋. The 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 gets written to disk, it's first written to a temporary file in the folder directory. For some reason, creating that file is impossible 🫠. Cast by create() 💀
  • Error: class $package does not implement method $method. — fatal error time, no cap: that specific $package (or one of its superclasses) does not implement this method where it should 😤. What this message means is that some other related classes do implement this method, but 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: $! — same deal as before, bestie: when a modified or new message is written to disk, it's 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, so you must specify its new destination, periodt 💅. If you have the urge not to specify any destination, you probably are looking for reply() instead. And 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. — so you may wish to construct a message that will be stored in some kind of folder, but you need to do that in two steps, bestie 👯. 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. — so 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. On first use, the messages are read from their file. Apparently, a message is used for the first time here, but has disappeared or is unreadable 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 💖

okay that's literally the whole page bestie, you made it to the end and I'm so proud of you 🥹💅 this was perl v5.40.1, dated 2026-05-09, and it's the Mail::...Message(3pm) manual — go forth and slay those messages, no cap 🌈✨🎀

📦 where this page comes from