NAME<\/a> Mail::Field \u2212 base\u2212class for manipulation of mail header fields<\/p>\n Mail::Field is extended by use Mail::Field; “Mail::Field” creates and manipulates fields in MIME<\/small> headers, collected within a Mail::Header object. Different field types have their own sub-class (extension), defining additional useful accessors to the field content.<\/p>\n People are invited to merge their implementation to special fields into MailTools, to maintain a consistent set of packages and documentation.<\/p>\n Constructors<\/b> Take a LIST<\/small> of “Mail::Field” objects (which should all be of the same sub-class) and create a new object in that same class.<\/p>\n Mail::Field\u2212>extract<\/b>( $tag, $head [, $index ] )<\/p>\n Takes as arguments the tag name, a “Mail::Head” object and optionally an index.<\/p>\n If the index argument is given then “extract” will retrieve the given tag from the “Mail::Head” object and create a new “Mail::Field” based object. undef<\/i> will be returned in the field does not exist.<\/p>\n If the index argument is not given the result depends on the context in which “extract” is called. If called in a scalar context the result will be as if “extract” was called with an index value of zero. If called in an array context then all tags will be retrieved and a list of “Mail::Field” objects will be returned.<\/p>\n Mail::Field\u2212>new<\/b>( $tag [, STRING<\/small> | %options] )<\/p>\n Create an object in the class which defines the field specified by the $tag argument.<\/p>\n “Fake” constructors<\/b> This constructor is used internally with preprocessed field information. When called on an existing object, its original content will get replaced.<\/p>\n $obj\u2212>parse<\/b>()<\/p>\n Parse a field line.<\/p>\n Accessors<\/b> Change the settings (the content, but then smart) of this field.<\/p>\n $obj\u2212>stringify<\/b>()<\/p>\n Returns the field as a string.<\/p>\n $obj\u2212>tag<\/b>() Return the tag (in the correct case) for this item. Well, actually any casing is OK,<\/small> because the field tags are treated case-insensitive; however people have some preferences.<\/p>\n Smart accessors<\/b> Without arguments, the field is returned as stringify()<\/b> does. Otherwise, the STRING<\/small> is parsed with parse()<\/b> to replace the object\u2019s content.<\/p>\n It is more clear to call either stringify()<\/b> or parse()<\/b> directly, because this method does not add additional processing.<\/p>\n SUB-CLASS PACKAGE NAMES<\/small><\/b>
INHERITANCE<\/a>
SYNOPSIS<\/a>
DESCRIPTION<\/a>
METHODS<\/a>
DETAILS<\/a>
DIAGNOSTICS<\/a>
SEE ALSO<\/a>
AUTHORS<\/a>
LICENSE<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
INHERITANCE <\/a> <\/h2>\n
Mail::Field::AddrList
Mail::Field::Date
Mail::Field::Generic<\/p>\nSYNOPSIS <\/a> <\/h2>\n
my $field = Mail::Field\u2212>new(‘Subject’, ‘some subject text’);
my $field = Mail::Field\u2212>new(Subject => ‘some subject text’);
print $field\u2212>tag,”: “,$field\u2212>stringify,”n”;
my $field = Mail::Field\u2212>subject(‘some subject text’);<\/p>\nDESCRIPTION <\/a> <\/h2>\n
METHODS <\/a> <\/h2>\n
Mail::Field (and it\u2019s sub-classes) define several methods which return new objects. These can all be categorized as constructor.
Mail::Field\u2212>combine<\/b>($fields)<\/p>\n
$obj\u2212>create<\/b>(%options)<\/p>\n
$obj\u2212>set<\/b>(%options)<\/p>\n
Mail::Field\u2212>tag<\/b>()<\/p>\n
$obj\u2212>text<\/b>( [ STRING<\/small> ] )<\/p>\nDETAILS <\/a> <\/h2>\n
All sub-classes should be called Mail::Field::name<\/i> where name<\/i> is derived from the tag using these rules.<\/p>\n