Mail::M...dy::File(3)

📦
version 4.04 · 11 versions
, in fedora 44

okay so bestie, welcome to Mail::Message::Body::File(3) from the User Contributed Perl Documentation 💖 this is the part where message bodies get a whole file to themselves, and honestly? main character energy.

✨ NAME ✨

Mail::Message::Body::File — body of a message temporarily stored in a file. periodt 💅

🧬 INHERITANCE 🧬

Mail::Message::Body::File
  is a Mail::Message::Body
  is a Mail::Reporter

  Mail::Message::Body also extends Mail::Reporter
  is a Mail::Reporter

📜 SYNOPSIS 📜

See Mail::Message::Body

💖 DESCRIPTION 💖

okay so the body (content) of a message can be stored in various ways. this doc is all about the extra functionality you get when a message is stored in a file. storing a whole message is a file is useful when the body is large. although access through a file is slower, it is saving a lot of memory. no cap.

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

🔥 OVERLOADED 🔥

Extends "OVERLOADED" in Mail::Message::Body.

  • overload: '""' stringification — Inherited, see "OVERLOADED" in Mail::Message::Body
  • overload: '==' numerical comparison — Inherited, see "OVERLOADED" in Mail::Message::Body
  • overload: '@{}' addressed as array — Inherited, see "OVERLOADED" in Mail::Message::Body
  • overload: bool true/false — Inherited, see "OVERLOADED" in Mail::Message::Body

🛠️ METHODS 🛠️

Extends "METHODS" in Mail::Message::Body.

🏗️ Constructors 🏗️

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

  • $obj->clone() — Inherited, see "Constructors" in Mail::Message::Body
  • $class->new(%options) — Inherited, see "Constructors" in Mail::Message::Body
the option menu is serving:
 -Option           --Defined in         --Default
  based_on           Mail::Message::Body  undef
  charset            Mail::Message::Body  'PERL'
  checked            Mail::Message::Body  false
  content_id         Mail::Message::Body  undef
  data               Mail::Message::Body  undef
  description        Mail::Message::Body  undef
  disposition        Mail::Message::Body  undef
  eol                Mail::Message::Body  'NATIVE'
  file               Mail::Message::Body  undef
  filename           Mail::Message::Body  undef
  language           Mail::Message::Body  undef
  message            Mail::Message::Body  undef
  mime_type          Mail::Message::Body  'text/plain'
  modified           Mail::Message::Body  false
  transfer_encoding  Mail::Message::Body  'none'

and the option shapes, exactly as they come:

  • based_on => $body — yep, that's the shape.
  • charset => $charset|'PERL'|<undef> — yep, that's the shape.
  • checked => BOOLEAN — yep, that's the shape.
  • content_id => STRING — yep, that's the shape.
  • data => \@lines|$text — yep, that's the shape.
  • description => STRING|$field — yep, that's the shape.
  • disposition => STRING|$field — yep, that's the shape.
  • eol => 'CR'|'LF'|'CRLF'|'NATIVE' — yep, that's the shape.
  • file => $file|$handle|$io — yep, that's the shape.
  • filename => $file — yep, that's the shape.
  • language => STRING|\@lang|$field — yep, that's the shape.
  • message => $message — yep, that's the shape.
  • mime_type => STRING|$field|$mime — yep, that's the shape.
  • modified => BOOLEAN — yep, that's the shape.
  • transfer_encoding => STRING|$field — yep, that's the shape.

🌸 Attributes 🌸

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

  • $obj->charsetDetectAlgorithm( [CODE|undef|METHOD] ) — Inherited, see "Attributes" in Mail::Message::Body::Encode

🧚 Constructing a body 🧚

Extends "Constructing a body" in Mail::Message::Body.

  • $obj->attach(@messages, %options) — Inherited, see "Constructing a body" in Mail::Message::Body::Construct
  • $obj->charsetDetect(%options) — Inherited, see "Constructing a body" in Mail::Message::Body::Encode
  • $obj->check() — Inherited, see "Constructing a body" in Mail::Message::Body::Encode
  • $obj->concatenate(@components) — Inherited, see "Constructing a body" in Mail::Message::Body::Construct
  • $obj->decoded(%options) — Inherited, see "Constructing a body" in Mail::Message::Body
  • $obj->encode(%options) — Inherited, see "Constructing a body" in Mail::Message::Body::Encode
  • $obj->encoded(%options) — Inherited, see "Constructing a body" in Mail::Message::Body::Encode
  • $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] ) — Inherited, see "Constructing a body" in Mail::Message::Body::Encode
  • $obj->foreachLine(CODE) — Inherited, see "Constructing a body" in Mail::Message::Body::Construct
  • $obj->stripSignature(%options) — Inherited, see "Constructing a body" in Mail::Message::Body::Construct
  • $obj->unify($body) — Inherited, see "Constructing a body" in Mail::Message::Body::Encode

🦋 The body 🦋

Extends "The body" in Mail::Message::Body.

  • $obj->isDelayed() — Inherited, see "The body" in Mail::Message::Body
  • $obj->isMultipart() — Inherited, see "The body" in Mail::Message::Body
  • $obj->isNested() — Inherited, see "The body" in Mail::Message::Body
  • $obj->message( [$message] ) — Inherited, see "The body" in Mail::Message::Body
  • $obj->partNumberOf($part) — Inherited, see "The body" in Mail::Message::Body

💅 About the payload 💅

Extends "About the payload" in Mail::Message::Body.

  • $obj->charset() — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->checked( [BOOLEAN] ) — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->contentId( [STRING|$field] ) — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->description( [STRING|$field] ) — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->disposition( [STRING|$field] ) — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->dispositionFilename( [$directory] ) — Inherited, see "About the payload" in Mail::Message::Body::Encode
  • $obj->isBinary() — Inherited, see "About the payload" in Mail::Message::Body::Encode
  • $obj->isText() — Inherited, see "About the payload" in Mail::Message::Body::Encode
  • $obj->language( [@langs|\@langs|$langs|$field] ) — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->mimeType() — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->nrLines() — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->size() — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->transferEncoding( [STRING|$field] ) — Inherited, see "About the payload" in Mail::Message::Body
  • $obj->type( [STRING|$field] ) — Inherited, see "About the payload" in Mail::Message::Body

🍓 Access to the payload 🍓

Extends "Access to the payload" in Mail::Message::Body.

  • $obj->endsOnNewline() — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->file() — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->lines() — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->print() — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->printEscapedFrom($fh) — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->string() — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->stripTrailingNewline() — Inherited, see "Access to the payload" in Mail::Message::Body
  • $obj->write(%options) — Inherited, see "Access to the payload" in Mail::Message::Body

🧠 Internals 🧠

Extends "Internals" in Mail::Message::Body.

  • $any->addTransferEncHandler( $name, <$class|$object> ) — Inherited, see "Internals" in Mail::Message::Body::Encode
  • $obj->contentInfoFrom($head) — Inherited, see "Internals" in Mail::Message::Body
  • $obj->contentInfoTo($head) — Inherited, see "Internals" in Mail::Message::Body
  • $obj->fileLocation( [$begin, $end] ) — Inherited, see "Internals" in Mail::Message::Body
  • $obj->getTransferEncHandler($type) — Inherited, see "Internals" in Mail::Message::Body::Encode
  • $obj->isModified() — Inherited, see "Internals" in Mail::Message::Body
  • $obj->load() — Inherited, see "Internals" in Mail::Message::Body
  • $obj->modified( [BOOLEAN] ) — Inherited, see "Internals" in Mail::Message::Body
  • $obj->moveLocation( [$distance] ) — Inherited, see "Internals" in Mail::Message::Body
  • $obj->read() — Inherited, see "Internals" in Mail::Message::Body
  • $obj->tempFilename( [$filename] ) — Returns the name of the temporary file which is used to store this body.

😭 Error handling 😭

Extends "Error handling" in Mail::Message::Body.

  • $obj->AUTOLOAD() — Inherited, see "Error handling" in Mail::Message::Body
  • $obj->notImplemented() — Inherited, see "Error handling" in Mail::Reporter
  • $obj->notImplemented() — Inherited, see "Error handling" in Mail::Reporter
yes bestie, notImplemented() is listed twice. the original said it twice, so we keep it twice. periodt.

🧼 Cleanup 🧼

Extends "Cleanup" in Mail::Message::Body.

  • $obj->DESTROY() — The temporary file is automatically removed when the body is not required anymore. Improves base, see "Cleanup" in Mail::Reporter

🌈 DETAILS 🌈

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

💀 DIAGNOSTICS 💀

okay bestie, here's the whole drama list of messages this thing can throw at you. Every single one, no skips, because the way I would never leave you hanging mid-error. 🫶

  • Warning: Content-Transfer-Encoding '$te' requires explicit charset, defaulted to utf-8. — Cast by encode()
  • Error: cannot concatenate element $which — Cast by concatenate()
  • Fault: cannot open $file to write body: $! — Cast by write()
  • Fault: cannot read from file $name: $! — Cast by nrLines()
  • Fault: cannot read from file $name: $! — Cast by string()
  • Fault: cannot read from file $name: $! — Cast by print()
  • Fault: cannot read from file $name: $! — Cast by endsOnNewline()
  • Fault: cannot read from file $name: $! — Cast by lines()
yes queen, that same message shows up five whole times with different Cast by lines. it's giving "reused outfit but make it fashion". still listing all of them. periodt. 💅
  • Fault: cannot write body to file $name: $! — Cast by new()
  • Fault: cannot write to file $name: $! — Cast by read()
  • Fault: cannot write to temporary body file $name: $! — The message body is to be stored in a temporary file (probably because it is a large body), but for the indicated reason, this file cannot be created. Cast by new()
  • Fault: cannot write to temporary body file $name: $! — Cast by new()
  • Warning: charset '$name' is not known. — The encoding or decoding of a message body encounters a character set which is not understood by Perl's Encode module. Cast by encode()
  • 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: 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()
twin. identical. same energy. yes it's in here twice, and yes I'm keeping it twice because the facts don't change just because it's lowkey redundant. 🦋
  • Fault: error closing $file after write body: $! — Cast by write()
  • Warning: no decoder defined for transfer encoding '$encoding'. — The data (message body) is encoded in a way which is not currently understood, therefore no decoding (or recoding) can take place. Cast by encode()
  • Warning: no encoder defined for transfer encoding '$encoding'. — The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned. Cast by encode()
  • Error: no filename parameter for write() body. — Cast by write()
  • Error: part number needs multi-part or nested. — Cast by partNumberOf()
  • Fault: unable to read file $name for message body file: $! — A Mail::Message::Body::File object is to be created from a named file, but it is impossible to read that file to retrieve the lines within. Therefore, no copy to a temporary file can be made. Cast by new()
  • Error: unknown line terminator '$eol'. — Cast by eol()

👀 SEE ALSO 👀

This module is part of Mail-Message version 4.04, built on February 04, 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.

and that's the whole page bestie, you made it to the end, iconic behavior honestly ✨ this was pulled from the manpage rendered by perl v5.42.0, dated 2026-02-05, filed under Mail::M...dy::File(3) — go forth and read your message bodies, you absolute legend 👑💖

📦 where this page comes from