Mail::...essage(3pm)
💌 NAME 💌
Mail::Box::File::Message — one message in a Mbox folder 🎀
oh and real quick, the manual-name vibe check: this page is Mail::...essage(3pm), filed under User Contributed Perl Documentation. iykyk ✨
🌈 INHERITANCE 🌈
bestie the family tree is giving dynasty:
Mail::Box::File::Message
is a Mail::Box::Message
is a Mail::Message
is a Mail::Reporter
Mail::Box::File::Message is extended by
Mail::Box::Mbox::Messageso it's a Mail::Box::Message, which is a Mail::Message, which is a Mail::Reporter. and Mail::Box::Mbox::Message extends it. generational wealth, honestly 👑
✨ SYNOPSIS ✨
the whole plot in two lines, no cap:
my $folder = new Mail::Box::File folder => $ENV{MAIL}, ...;
my $message = $folder->message(0);🦋 DESCRIPTION 🦋
okay so this class maintains one single message inside a file-based folder — and by "file-based" we mean any Mail::Box::File extension. that's the whole job. main character energy for one message 💅
Extends "DESCRIPTION" in Mail::Box::Message.
💅 METHODS 💅
Extends "METHODS" in Mail::Box::Message.
🎀 Constructors 🎀
Extends "Constructors" in Mail::Box::Message.
$obj->clone(%options)— Inherited, see "Constructors" in Mail::Message$class->new(%options)— messages in file-based folders use these options when you create them. Improves base, see "Constructors" in Mail::Reporter.
here's the full lineup, bestie — Option, where it's Defined, and its Default, all three columns accounted for:
-Option --Defined in --Default
body Mail::Message undef
body_type Mail::Box::Message <from folder>
deleted Mail::Message false
field_type Mail::Message undef
folder Mail::Box::Message <required>
from_line undef
head Mail::Message undef
head_type Mail::Message Mail::Message::Head::Complete
labels Mail::Message +{}
messageId Mail::Message undef
message_id Mail::Message undef
modified Mail::Message false
size Mail::Box::Message undef
trusted Mail::Message falseand one by one now, bc we don't skip anyone in this house 🫶
body=>$objectbody_type=>CODE|$classdeleted=>BOOLEANfield_type=>$classfolder=>$folderfrom_line=>$line— this is the$linethat kicks off every single message in the file. some people detest this line, bestie, but that's just how things were invented... 💀head=>$objecthead_type=>$classlabels=>\@pairs|\%settingsmessageId=>$idmessage_id=>$idmodified=>BOOLEANsize=>$bytestrusted=>BOOLEAN
🌸 Attributes 🌸
Extends "Attributes" in Mail::Box::Message.
$obj->bodyType()— Inherited, see "Attributes" in Mail::Message$obj->fieldType()— Inherited, see "Attributes" in Mail::Message$obj->folder( [$folder] )— Inherited, see "Attributes" in Mail::Box::Message$obj->fromLine( [$line] )— okay so many people detest file-style folders because they shove all the messages into one single file, and the line that starts withFromis what leads the header. if we receive a message from a file-based folder, we store that line. if we write to such a file but there's no such line stored, then we try to generate one. periodt.
and if $line gets provided? then the starting line is set to this value. 💅
$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->escapedBody()— Mbox folders hold multiple messages in one file and use a separator line to keep them apart. typically those lines start withFrom. lines inside the message could interfere with that separator, so they should be translated. ✨
this method returns the escaped text of the body as a reference.
$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] )— writes one message out to a file handle. it's the message including the leading'From 'line and the trailing blank. heads up tho: the From-line may interfere with lines in the body, and those lines get escaped with an extra'>'. Improves base, see "The message" in Mail::Message.
» example:
$msg->write(\*FILE); # print the message with encaps to FILE
$msg->write; # message with encaps to selected filehandle
$msg->print(\*FILE); # the message without encaps.🎀 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->diskDelete()— Inherited, see "Internals" in Mail::Box::Message$obj->fileLocation()— returns the location of the whole message, from-line included. in LIST context you get both the begin and the end back. in SCALAR context, only the begin gets passed back.$obj->isDelayed()— Inherited, see "Internals" in Mail::Message$obj->isTrusted()— Inherited, see "Internals" in Mail::Message$obj->loadBody()$obj->moveLocation($distance)— the message gets relocated inside the file, shifted over by $distance bytes. And bestie, when you set a new location, it updates the matching info in both the header and the body. everything stays in sync, no crumbs left. 💫$obj->readBody( $parser, $head, [$bodytype] )— inherited, see "Internals" inMail::Box::Message$obj->readFromParser($parser)— reads one whole message out of aMail::Box::Filebased folder, leading message separator included, no skipping. Improves base, see "Internals" inMail::Message$obj->readHead( $parser, [$class] )— inherited, see "Internals" inMail::Message$obj->recursiveRebuildPart($part, %options)— inherited, see "Internals" inMail::Message::Construct::Rebuild$obj->storeBody($body)— inherited, see "Internals" inMail::Message$obj->takeMessageId( [STRING] )— inherited, see "Internals" inMail::Message
💅 Error handling (but make it cute)
Extends "Error handling" in Mail::Box::Message. so this is the family drama part of the module, inherited straight down the line.
$obj->AUTOLOAD()— inherited, see "METHODS" inMail::Message::Construct$obj->notImplemented()— inherited, see "Error handling" inMail::Reporter$any->shortSize( [$value] )— inherited, see "Error handling" inMail::Message$obj->shortString()— inherited, see "Error handling" inMail::Message
🧹 Cleanup
Extends "Cleanup" in Mail::Box::Message. the part where we tidy up and log off, periodt.
$obj->DESTROY()— inherited, see "Cleanup" inMail::Reporter$obj->destruct()— inherited, see "Cleanup" inMail::Box::Message
🌈 DETAILS 🌈
Extends "DETAILS" in Mail::Box::Message. yeah that's literally it, it's giving inheritance and nothing else. go read the parent's tea. 🫖
💀 DIAGNOSTICS 💀
this is the part where the module yells at you. buckle up bestie, we're going through every single one. 🚨
Error: Cannot include forward source as $kind.— unknown alternative for theforward(include). the valid choices are"NO","INLINE","ATTACH", and"ENCAPSULATE". cast byforward()Error: No default mailer found to send message.— the messagesend()mechanism didn't have enough info to auto-find a mail transfer agent to send this message. so specify a mailer explicitly using the"via"options. cast bysend()Error: Unable to read delayed body.— cast byloadBody()Error: cannot coerce a $type object into a $me object.— cast bycoerce()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 byread()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 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 bynotImplemented()Error: coercion starts with some object, not '$type'.— cast bycoerce()Error: method bounce requires To, Cc, or Bcc.— the messagebounce()method forwards a received message off to someone else without modification, so you must specify its new destination. if you have the urge not to specify any destination, you're probably looking forreply(). when you wish to modify the content, useforward(). cast bybounce()Error: method forwardAttach requires a preamble.— cast byforwardAttach()Error: method forwardEncapsulate requires a preamble.— cast byforwardEncapsulate()Error: method forwardNo requires a To.— cast byforwardNo()Error: method forwardNo requires a body.— cast byforwardNo()Error: no rebuild rule $name defined.— cast byrebuild()Error: only build() Mail::Message's; they are not in a folder yet.— you may wish to construct a message to be stored in some kind of folder, but you gotta do that in two steps. first, create a normalMail::Message, and then add it to the folder. during thisMail::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 bycoerce()Error: please install MIME::Entity.— cast bycoerce()Error: please install Mail::Internet.— cast bycoerce()Error: select parts via '$what'?— cast byparts()Warning: skipped unknown key '$key' in build.— cast bybuild()
👀 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. slay and legal, the best combo. 💖
and that's a wrap on part two, bestie!! 🎀 source was perl v5.40.1, page dated 2026-05-09 — iconic, no cap, fr fr. now go read the parent docs and hydrate. 💅✨🦋
📦 where this page comes from
- ubuntu stonking: libmail-box-perl 4.02-1 · Artistic-1.0-Perl OR GPL-1.0-or-later
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms