Mail::M...lHeader(3)

📦

version 4.04 · 11 versions

💖 Mail::Message::Replace::MailHeader(3)

okay bestie, welcome to Mail::Message::Replace::MailHeader(3) — yes that's the whole name, she's long but she's worth it 💅. This is the User Contributed Perl Documentation corner of the universe, and we're about to make a fake Mail::Header and have it be, lowkey, iconic.

✨ NAME ✨

Mail::Message::Replace::MailHeader — a fake Mail::Header, no cap 🎭

🌸 INHERITANCE 🌸

she's got a whole ancestry tree and honestly the bloodline ate:

Mail::Message::Replace::MailHeader
  is a Mail::Message::Head::Complete
  is a Mail::Message::Head
  is a Mail::Reporter

like, look at that lineage. main character energy all the way up 🫶

🦋 SYNOPSIS 🦋

here's the glow-up, bestie. you take this:

# change
use Mail::Internet;
use Mail::Header;

and you turn it into this:

# into
use Mail::Message::Replace::MailInternet;
# in existing code, and the code should still work, but
# with the Mail::Message features.

that's it. swap the use, keep your existing code, and she still runs — but now she's got all the Mail::Message features. glow-up complete ✨

💜 DESCRIPTION 💜

so here's the tea 🍓: this module is a lil wrapper around a Mail::Message::Head::Complete, and what it does is simulate a Mail::Header object. it literally hijacks that module's name-space and then piles a whole bunch of extra methods on top of it. not me committing identity theft for the greater good 😭

most methods will just work with zero changes, but bestie, you should test your software again. no skipping the vibe check. small changes have been made to fold_length() and header_hashref(). so, like, mostly fine, but not identical fine.

also, this extends "DESCRIPTION" in Mail::Message::Head::Complete — so go read that one too, iykyk 📚

🎀 OVERLOADED 🎀

extends "OVERLOADED" in Mail::Message::Head::Complete. the family keeps growing 💖

overload: "" stringifaction — inherited, see "OVERLOADED" in Mail::Message::Head. yes it says "stringifaction", that's the original spelling, we don't touch the sacred texts 🙈
overload: bool true/false — inherited, see "OVERLOADED" in Mail::Message::Head

ngl "overload" sounds like a lot but it's just Perl letting objects pretend to be strings and booleans. cute, honestly. 🧚

🛠️ METHODS 🛠️

Extends "METHODS" in Mail::Message::Head::Complete. So like, everything below is the bonus content on top of what that class already gives you, bestie. 💖

🎀 Constructors 🎀

Extends "Constructors" in Mail::Message::Head::Complete.

$class->build( [PAIR|$field], ... ) — Inherited, so go peep "Constructors" in Mail::Message::Head::Complete for the tea.
$obj->clone( [@names|ARRAY|Regexps] ) — Also inherited, same deal: "Constructors" in Mail::Message::Head::Complete.
$class->new( [$arg], %options ) — The $arg is an array with header lines. This one improves the base version, so check "Constructors" in Mail::Message::Head too. ✨

Here's the whole options lineup, fr fr:

 -Option    --Defined in         --Default
  FoldLength                       79
  MailFrom                         'KEEP'
  Modify                           false
  field_type  Mail::Message::Head  Mail::Message::Field::Fast
  message     Mail::Message::Head  undef
  modified    Mail::Message::Head  false

Now let's break each one down:

FoldLength => $octets — the fold length, in octets. That's it, that's the whole vibe.
MailFrom => 'IGNORE'|'ERROR'|'COERCE'|'KEEP' — how you wanna handle those "From " lines. Full deets live in mail_from(). 👀
Modify => BOOLEAN — reformat every header line as it comes in, i.e. change the folding. Glow-up on arrival.
field_type => CLASS — which class the fields get built as.
message => $message — the message this header belongs to.
modified => BOOLEAN — whether it's been modified.

📋 Attributes 📋

Extends "Attributes" in Mail::Message::Head::Complete.

💌 The header 💌

Extends "The header" in Mail::Message::Head::Complete.

$obj->isDelayed() — Inherited, see "The header" in Mail::Message::Head.
$obj->isEmpty() — Inherited, see "The header" in Mail::Message::Head.
$obj->isModified() — Inherited, see "The header" in Mail::Message::Head.
$obj->knownNames() — Inherited, see "The header" in Mail::Message::Head.
$obj->message( [$message] ) — Inherited, see "The header" in Mail::Message::Head.
$obj->modified( [BOOLEAN] ) — Inherited, see "The header" in Mail::Message::Head.
$obj->nrLines() — Inherited, see "The header" in Mail::Message::Head::Complete.
$obj->orderedFields() — Inherited, see "The header" in Mail::Message::Head.
$obj->size() — Inherited, see "The header" in Mail::Message::Head::Complete.
$obj->wrap($integer) — Inherited, see "The header" in Mail::Message::Head::Complete.

🔍 Access to the header 🔍

Extends "Access to the header" in Mail::Message::Head::Complete.

$obj->add( $line, [$index] ) — Adds a header line, and honestly it just calls Mail::Message::Head::add() on the header for that $line. The $index gets straight-up ignored 🙈, and what comes back is the unfolded body of the field. Improves the base, so also see "Access to the header" in Mail::Message::Head::Complete.
$obj->addListGroup($object) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->addResentGroup($resent_group|$data) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->addSpamGroup($object) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->count($name) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->delete( $tag, [$index] ) — Deletes the fields with that $tag, and hands you back the deleted fields. No index given? Then all of them go. 💀 Improves the base — see "Access to the header" in Mail::Message::Head::Complete.
$obj->get( $name, [$index] ) — Grabs all the header fields matching $name. In scalar context you only get the first fitting $name back. And even when you name just one $name, you might get multiple lines back in list context, because some fields just show up more than once in a header. Iconic, honestly. Improves the base — see "Access to the header" in Mail::Message::Head.
$obj->grepNames( [@names|ARRAY|Regexps] ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->listGroup() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->names() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->print( [$fh] ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->printSelected($fh, <STRING|Regexp>, ...) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->printUndisclosed( [$fh] ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeContentInfo() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeField($field) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeFields( <STRING|Regexp>, ... ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeFieldsExcept( <STRING|Regexp>, ... ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeListGroup() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeResentGroups() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->removeSpamGroups() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->replace( $tag, $line, [$index] ) — Swaps out the field named $tag, from place $index (defaulting to the first one), with $line. If $tag is undef, it gets pulled out of $line first. Heads up: this calls Mail::Message::Head::Complete::reset() on the message's head. 🔁
$obj->resentGroups() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->reset($name, @fields) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->set( $field | $line | <$name, $body, [$attrs]> ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->spamDetected() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->spamGroups( [$names] ) — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->string() — Inherited, see "Access to the header" in Mail::Message::Head::Complete.
$obj->study( $name, [$index] ) — Inherited, see "Access to the header" in Mail::Message::Head.

🫧 About the body 🫧

Extends "About the body" in Mail::Message::Head::Complete.

$obj->guessBodySize() — Inherited, see "About the body" in Mail::Message::Head.
$obj->guessTimeStamp() — Inherited, see "About the body" in Mail::Message::Head::Complete.
$obj->isMultipart() — Inherited, see "About the body" in Mail::Message::Head.
$obj->recvstamp() — Inherited, see "About the body" in Mail::Message::Head::Complete.
$obj->timestamp() — Inherited, see "About the body" in Mail::Message::Head::Complete.

🧚 Internals 🧚

Extends "Internals" in Mail::Message::Head::Complete.

$obj->addNoRealize($field) — Inherited, see "Internals" in Mail::Message::Head.
$obj->addOrderedFields($fields) — Inherited, see "Internals" in Mail::Message::Head.
$obj->createFromLine() — Inherited, see "Internals" in Mail::Message::Head::Complete.
$obj->createMessageId() — Inherited, see "Internals" in Mail::Message::Head::Complete.
$obj->fileLocation() — Inherited, see "Internals" in Mail::Message::Head.
$obj->load() — Inherited, see "Internals" in Mail::Message::Head.
$any->messageIdPrefix( [$prefix, [$hostname]|CODE] ) — Inherited, see "Internals" in Mail::Message::Head::Complete.
$obj->moveLocation($distance) — Inherited, see "Internals" in Mail::Message::Head.
$obj->setNoRealize($field) — Inherited, see "Internals" in Mail::Message::Head.

🚨 Error handling 🚨

Extends "Error handling" in Mail::Message::Head::Complete.

$obj->AUTOLOAD() — Inherited, see "Error handling" in Mail::Reporter.
$obj->notImplemented() — Inherited, see "Error handling" in Mail::Reporter.

🧹 Cleanup 🧹

Extends "Cleanup" in Mail::Message::Head::Complete.

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

🔍 Access to the header 🔍

(yes, bestie, it's back — same heading, new vibes 💅)

🎭 Simulating `Mail::Header` 🎭

$obj->as_string() — Hands you the entire header as one big scalar. Under the hood it calls Mail::Message::Head::Complete::string().
$obj->cleanup() — Cleans up memory usage. Not needed here, so like, nothing to do. 🧼
$obj->combine( $tag, [$with] ) — "I do not see any valid reason for this command, so did not implement it." No notes, the author said what they said. 💀
$obj->dup() — Duplicates the header, which is literally just clone().
$obj->empty() — Cleans out the whole hash. Better not use this (just make another header object instead), although it should work. 😭
$obj->exists() — Tells you whether there are any fields at all.
$obj->extract(\@lines) — Extracts (and removes) header fields from the array.
$obj->fold( [$length] ) — Refolds every field in the header, to $length or whatever fold_length() gives back.
$obj->fold_length( [[$tag], $length] ) — Returns the line wrap, optionally after setting it to $length. You get the old value back. The $tag argument is ignored, because having different lines fold in different ways is silly. ⚠️ Heads up: this method cannot be called statically anymore.
$obj->header( [ARRAY] ) — Extracts the fields from the ARRAY if you gave one, then folds the fields. You get back an array with all the fields, produced via orderedFields().
$obj->header_hashref(HASH) — "If you are using this method, you must be stupid... anyway: I do not want to support it for now: use add() and friends." Okay drag us a little, king. 🙈
$obj->mail_from( ['IGNORE'|'ERROR'|'COERCE'|'KEEP'] ) — What to do when a header line in the form `From ' shows up. The valid values are "IGNORE" — ignore it and discard the header, "ERROR" — invoke an error (die), "COERCE" — rename them as Mail-From, and "KEEP" — keep them. Choose wisely bestie. ✨
$obj->modify( [BOOLEAN] ) — Refolds the headers as they get added.
$obj->read($file) — Reads the header from $file. Improves the base — see "Internals" in Mail::Message::Head.
$obj->tags() — Returns all the names of fields, implemented by Mail::Message::Head::Complete::names().
$obj->unfold( [$tag] ) — Removes the folding for every instance of $tag, or for all fields at once if you skip it.

😈 The nasty bits 😈

$any->isa($class) — Obviously, the isa() class inheritance check should not see our nasty little trick. 🤫

🌈 DETAILS 🌈

Extends "DETAILS" in Mail::Message::Head::Complete.

💀 DIAGNOSTICS 💀

okay bestie, here's where the module yells at you. these are the messages it can throw, and what they actually mean 👇

Error: bad Mail-From choice: '$pick'. — you passed a $pick value that is simply not it. no cap. cast by mail_from(). 🫠
Warning: cannot remove field $name from header: not found. — you asked to remove a field that the header literally does not know about. but here's the tea: if you use delete(), reset(), or set() instead, you won't get this warning, because those methods check whether the field exists first. this one comes from removeField(). 🧚
Error: class $package does not implement method $method. — this is a fatal error, so pay attention 💅. it means the specific $package (or one of its superclasses, like, going all the way up the family tree) doesn't implement this method even though it should. the vibe is: some other related classes do implement it, but this class right here does not. you should probably investigate this, and honestly probably tell the author of the package about it. cast by notImplemented(). 😭
Warning: field objects have an implied name ($name) — cast by build(). 🎀

🌈 SEE ALSO 🌈

this module is part of Mail-Message version 4.04, built on February 04, 2026. 🌸

website: http://perl.overmeer.net/CPAN/

like. go look at it. it's giving resource. 👑

📜 LICENSE 📜

contributors, check out the file ChangeLog bestie. 🫶

it's free software, so you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. iconic behavior honestly. ✨

and that's the whole page, bestie!! 🎉 this one came from the perl v5.42.0 manual, dated 2026-02-05 — so like, fresh off the press. go forth and header responsibly. mwah 💖💅

📦 where this page comes from

fedora 44: perl-Mail-Message 4.04-1.fc44 · GPL-1.0-or-later OR Artistic-1.0-Perl
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

Mail::M...lHeader(3)

💖 Mail::Message::Replace::MailHeader(3)

✨ NAME ✨

🌸 INHERITANCE 🌸

🦋 SYNOPSIS 🦋

💜 DESCRIPTION 💜

🎀 OVERLOADED 🎀

🛠️ METHODS 🛠️

🎀 Constructors 🎀

📋 Attributes 📋

💌 The header 💌

🔍 Access to the header 🔍

🫧 About the body 🫧

🧚 Internals 🧚

🚨 Error handling 🚨

🧹 Cleanup 🧹

🔍 Access to the header 🔍

🎭 Simulating Mail::Header 🎭

😈 The nasty bits 😈

🌈 DETAILS 🌈

💀 DIAGNOSTICS 💀

🌈 SEE ALSO 🌈

📜 LICENSE 📜

🎭 Simulating `Mail::Header` 🎭