Mail::...::Head(3pm)

💖 Mail::...::Head — the tea ☕

ok so bestie, we're looking at Mail::...::Head, which lives in the User Contributed Perl Documentation corner of the perl world (that's the 3pm part, iykyk). Buckle up, we're doing IMAP vibes today 🦋

---

✨ NAME ✨

Mail::Box::IMAP4::Head — header fields related IMAP interface. it's giving "the header but make it IMAP4" 💅

---

🌸 INHERITANCE 🌸

the family tree, periodt:

Mail::Box::IMAP4::Head
  is a Mail::Message::Head
  is a Mail::Reporter

so it's a grandbaby of Mail::Reporter, no cap 🌈

---

🎀 SYNOPSIS 🎀

bestie... there is literally nothing here. the synopsis section is empty. an icon of minimalism fr fr 💀✨

---

👑 DESCRIPTION 👑

okay so this class implements a pure IMAP4 protocol interface, where as little data is retrieved from the header as possible. sounds chic, right? 🙈 yeah well — it may look nice to you, but it is not sufficient for many tasks. for instance, you cannot remove or modify fields this way. not me finding out the hard way 😭

want a header that can actually do all the games? change Mail::Box::IMAP4::new(cache_head) to "YES" or "DELAY", and you'll get a message header which is capable of performing all possible games with headers. slay 💅

⚠️ but on the other hand: the other settings are not 100% safe... so choose your fighter wisely bestie

Extends "DESCRIPTION" in Mail::Message::Head. 🫶

---

💫 OVERLOADED 💫

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

• overload: "" stringifaction — Inherited, see "OVERLOADED" in Mail::Message::Head
• overload: bool true/false — Inherited, see "OVERLOADED" in Mail::Message::Head

like it literally knows how to be a string and a boolean. main character energy ⭐

---

🔥 METHODS 🔥

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

---

🧸 Constructors

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

• $class->build( [PAIR|$field]-LIST ) — Inherited, see "Constructors" in Mail::Message::Head
• $class->new(%options) — Inherited, see "Constructors" in Mail::Message::Head

the options table, and bestie the defaults are right there in columns, look:

 -Option      --Defined in         --Default
  cache_fields                       false
  field_type    Mail::Message::Head  Mail::Message::Field::Fast
  message       Mail::Message::Head  undef
  modified      Mail::Message::Head  false

• cache_fields => BOOLEAN — this is only a read-cache on fields, because this kind of header does not allow writing of fields. see Mail::Box::IMAP4::new(cache_head) — this value is set to "false" for "NO" and "true" for "PARTIAL". (yes, two dots, that's the original, don't come for me 🫠)
• field_type => CLASS
• message => $message
• modified => BOOLEAN

---

🦋 Attributes

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

---

🌸 The header

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

• $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->orderedFields() — Inherited, see "The header" in Mail::Message::Head

---

💜 Access to the header

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

• $obj->get( $name, [$index] ) — get the information about the header line $name. realization will take place. improves base, see "Access to the header" in Mail::Message::Head 🔥
• $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.

• $obj->guessBodySize() — Inherited, see "About the body" in Mail::Message::Head
• $obj->isMultipart() — Inherited, see "About the body" in Mail::Message::Head

---

🧚 Internals

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

• $obj->addNoRealize($field) — Inherited, see "Internals" in Mail::Message::Head
• $obj->addOrderedFields($fields) — Inherited, see "Internals" in Mail::Message::Head
• $obj->fileLocation() — Inherited, see "Internals" in Mail::Message::Head
• $obj->load() — Inherited, see "Internals" in Mail::Message::Head
• $obj->moveLocation($distance) — Inherited, see "Internals" in Mail::Message::Head
• $obj->read($parser) — 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.

• $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.

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

---

🌈 DETAILS 🌈

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

---

⭐ DIAGNOSTICS ⭐

• 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(). it's giving "not my job but someone's job" 😭

---

🫶 SEE ALSO 🫶

this module is part of Mail-Box-IMAP4 version 4.01, built on December 13, 2025. Website: http://perl.overmeer.net/CPAN/ — go peek, bestie ✨

---

🎀 LICENSE 🎀

for contributors see file ChangeLog.

this software is copyright (c) 2001-2025 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. iconic, generous, legendary 👑

---

and that's the whole page, bestie 💖 written up by perl v5.40.1, dated 2026-01-21, answering to the name Mail::...::Head(3pm) — she ate and left no crumbs 💅🦋🌸