Mail::Message::Field::Addresses - Fields with e-mail addresses
Mail::Message::Field::Addresses is a Mail::Message::Field::Structured is a Mail::Message::Field::Full is a Mail::Message::Field is a Mail::Reporter
my $cc = Mail::Message::Field::Full->new('Cc'); my $me = Mail::Message::Field::Address->parse('"Test" <test@mail.box>') or die; my $other = Mail::Message::Field::Address->new(phrase => 'Other' , address => 'other@example.com') or die; $cc->addAddress($me); $cc->addAddress($other, group => 'them'); $cc->addAddress(phrase => 'third', address => 'more@any.museum' , group => 'them'); my $group = $cc->addGroup(name => 'collegues'); $group->addAddress($me); $group->addAddress(phrase => "You", address => 'you@example.com'); my $msg = Mail::Message->build(Cc => $cc); print $msg->string; my $g = Mail::Message::Field::AddrGroup->new(...); $cc->addGroup($g);
All header fields which contain e-mail addresses only. Not all address fields have the same possibilities, but they are all parsed the same: you never know how broken the applications are which produce those messages.
When you try to create constructs which are not allowed for a certain kind of field, you will be warned.
Extends "DESCRIPTION" in Mail::Message::Field::Structured.
Extends "OVERLOADED" in Mail::Message::Field::Structured.
Inherited, see "OVERLOADED" in Mail::Message::Field
Inherited, see "OVERLOADED" in Mail::Message::Field::Full
Extends "METHODS" in Mail::Message::Field::Structured.
Extends "Constructors" in Mail::Message::Field::Structured.
Inherited, see "Constructors" in Mail::Message::Field
Inherited, see "Constructors" in Mail::Message::Field::Full
-Option --Defined in --Default attributes Mail::Message::Field::Structured <ignored> charset Mail::Message::Field::Full undef datum Mail::Message::Field::Structured undef encoding Mail::Message::Field::Full 'q' force Mail::Message::Field::Full false language Mail::Message::Field::Full undef log Mail::Reporter 'WARNINGS' trace Mail::Reporter 'WARNINGS'
Extends "The field" in Mail::Message::Field::Structured.
Inherited, see "The field" in Mail::Message::Field
Extends "Access to the name" in Mail::Message::Field::Structured.
Inherited, see "Access to the name" in Mail::Message::Field
Extends "Access to the body" in Mail::Message::Field::Structured.
Inherited, see "Access to the body" in Mail::Message::Field
Inherited, see "Access to the body" in Mail::Message::Field::Full
Extends "Access to the content" in Mail::Message::Field::Structured.
Add an $address to the field. The addresses are organized in groups. If no group is specified, the default group is taken to store the address in. If no $address is specified, the option must be sufficient to create a Mail::Message::Field::Address from. See the %options of Mail::Message::Field::Address::new().
-Option--Default group ''
Attributes are not supported for address fields.
Add a group of addresses to this field. A $group can be specified, which is a Mail::Message::Field::AddrGroup object, or one is created for you using the %options. The group is returned.
-Option--Default name ''
Returns a list with all addresses defined in any group of addresses: all addresses which are specified on the line. The addresses are Mail::Message::Field::Address objects.
example:
my @addr = $field->addresses;
Inherited, see "Access to the content" in Mail::Message::Field::Structured
Inherited, see "Access to the content" in Mail::Message::Field::Full
Inherited, see "Access to the content" in Mail::Message::Field
Returns the group of addresses with the specified $name, or undef if it does not exist. If $name is undef, then the default groep is returned.
undef
Returns a list with all group names which are defined.
Returns all address groups which are defined in this field. Each element is a Mail::Message::Field::AddrGroup object.
Extends "Other methods" in Mail::Message::Field::Structured.
Inherited, see "Other methods" in Mail::Message::Field
Extends "Internals" in Mail::Message::Field::Structured.
Inherited, see "Internals" in Mail::Message::Field
Inherited, see "Internals" in Mail::Message::Field::Full
Extends "Parsing" in Mail::Message::Field::Structured.
Try to destilate address information from the STRING. Returned are an address object and the left-over string. If no address was found, the first returned value is undef.
Inherited, see "Parsing" in Mail::Message::Field::Full
Try to get a valid domain representation from STRING. Returned are the domain string as found (or undef) and the rest of the string.
Inherited, see "Parsing" in Mail::Message::Field::Structured
Extends "Error handling" in Mail::Message::Field::Structured.
Inherited, see "Error handling" in Mail::Reporter
Extends "Cleanup" in Mail::Message::Field::Structured.
Inherited, see "Cleanup" in Mail::Reporter
Extends "DETAILS" in Mail::Message::Field::Structured.
The numeric value of a field is requested (for instance the Lines or Content-Length fields should be numerical), however the data contains weird characters.
Lines
Content-Length
The field is created with an utf8 string which only contains data from the specified character set. However, that character set can never be a valid name because it contains characters which are not permitted.
A new field is being created which does contain characters not permitted by the RFCs. Using this field in messages may break other e-mail clients or transfer agents, and therefore mutulate or extinguish your message.
The field is created with data which is specified to be in a certain language, however, the name of the language cannot be valid: it contains characters which are not permitted by the RFCs.
The RFCs only permit base64 (b or B ) or quoted-printable (q or Q) encoding. Other than these four options are illegal.
b
B
q
Q
Is is not possible to add attributes to address fields: it is not permitted by the RFCs.
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.
This module is part of Mail-Box distribution version 2.111, built on January 24, 2014. Website: http://perl.overmeer.net/mailbox/
Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
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
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.