Mail::F...Generic(3)

🌸 NAME 🌸

Mail::Field::Generic — implementation for inspecific fields. Yes, that's the whole vibe: a generic header-field implementation for fields that don't have their own special implementation. And the manual page you're reading? It's Mail::F...Generic(3), folded in right here like a lil name tag. 🏷️

🧬 INHERITANCE 🧬

Mail::Field::Generic is a Mail::Field. That's the inheritance chain, bestie. 💅

🌀 SYNOPSIS 🌀

okay so the synopsis is literally this:

use Mail::Field;
my $field = Mail::Field->new('Subject', 'some subject text');
my $field = Mail::Field->new(subject => 'some subject text');

🌈 DESCRIPTION 🌈

A generic implementation for header fields that don't have their own implementation. This is fine for fields like Subject, X-Mailer, etc., where the field holds only a string of no particular importance/format. No cap, it's just a string doing its little thing.

Extends DESCRIPTION in Mail::Field.

🛠️ METHODS 🛠️

Extends METHODS in Mail::Field.

🧱 Constructors 🧱

Extends Constructors in Mail::Field.

• Mail::Field::Generic->combine($fields) — inherited, see Constructors in Mail::Field.
• Mail::Field::Generic->extract( $tag, $head [, $index ] ) — inherited, see Constructors in Mail::Field.
• Mail::Field::Generic->new( $tag [, STRING | %options] ) — inherited, see Constructors in Mail::Field.

All three are inherited, so the actual constructor lore lives over in Mail::Field. 🫶

🎭 "Fake" constructors 🎭

Extends "Fake" constructors in Mail::Field.

$obj->create(%options) — the option table is small and iconic:

-Option--Default
 Text    ''

So Text => STRING is the option, and the default Text value is '' (empty string). 🎀

$obj->parse( [STRING] ) — sets the new text, which is empty when no STRING is provided. Empty string energy when you give it nothing. 🫧

🔑 Accessors 🔑

Extends Accessors in Mail::Field.

• $obj->set(%options) — inherited, see Accessors in Mail::Field.
• $obj->stringify() — inherited, see Accessors in Mail::Field.
• $obj->tag() / Mail::Field::Generic->tag() — inherited, see Accessors in Mail::Field.

✨ Smart accessors ✨

Extends Smart accessors in Mail::Field.

• $obj->text( [STRING] ) — inherited, see Smart accessors in Mail::Field.

🔍 DETAILS 🔍

Extends DETAILS in Mail::Field.

🚨 DIAGNOSTICS 🚨

If you hit Error: Undefined subroutine <method> called, here's the tea: Mail::Field objects use autoloading to compile new functionality. Apparently, the method called is not implemented for the specific class of the field object. So that's the diagnostic: this method isn't implemented for this class. 💀

👀 SEE ALSO 👀

This module is part of the MailTools distribution, http://perl.overmeer.net/mailtools/. Go peek, bestie. 🦋

👑 AUTHORS 👑

The MailTools bundle was developed by Graham Barr. Later, Mark Overmeer took over maintenance without commitment to further development. Important: "without commitment to further development" is literally in the original, so don't come for me. 😭

• Mail::Cap by Gisle Aas <aas@oslonett.no>.
• Mail::Field::AddrList by Peter Orbaek <poe@cit.dk>.
• Mail::Mailer and Mail::Send by Tim Bunce <Tim.Bunce@ig.co.uk>.
• For other contributors see ChangeLog.

📜 LICENSE 📜

Copyrights 1995-2000 Graham Barr <gbarr@pobox.com> and 2001-2024 Mark Overmeer <perl@overmeer.net>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html.

Free software, same terms as Perl, iconic legal realness. ✨

---

💌 That's the whole manual, bestie. Footer tea: source/version perl v5.42.0, date 2024-12-12, and the page name is Mail::F...Generic(3). Byeee! 🫶