Mail::Message::Field::Address - One e-mail address
Mail::Message::Field::Address is a Mail::Identity is an User::Identity::Item
my $addr = Mail::Message::Field::Address->new(...); my $ui = User::Identity->new(...); my $addr = Mail::Message::Field::Address->coerce($ui); my $mi = Mail::Identity->new(...); my $addr = Mail::Message::Field::Address->coerce($mi); print $addr->address; print $addr->fullName; # possibly unicode! print $addr->domain;
Many header fields can contain e-mail addresses. Each e-mail address can be represented by an object of this class. These objects will handle interpretation and character set encoding and decoding for you.
Extends "DESCRIPTION" in Mail::Identity.
The object used as boolean will always return true
true
Two address objects are the same when their email addresses are the same.
When the object is used in string context, it will return the encoded representation of the e-mail address, just like string() does.
Extends "METHODS" in Mail::Identity.
Extends "Constructors" in Mail::Identity.
Try to coerce the $object into a Mail::Message::Field::Address. In case of a STRING, it is interpreted as an email address.
Mail::Message::Field::Address
The %options are passed to the object creation, and overrule the values found in the $object. The result may be undef or a newly created object. If the $object is already of the correct type, it is returned unmodified.
undef
The $object may currently be a Mail::Address, a Mail::Identity, or a User::Identity. In case of the latter, one of the user's addresses is chosen at random.
Inherited, see "Constructors" in Mail::Identity
Parse the string for an address. You never know whether one or more addresses are specified on a line (often applications are wrong), therefore, the STRING is first parsed for as many addresses as possible and then the one is taken at random.
Extends "Attributes" in Mail::Identity.
Inherited, see "Attributes" in Mail::Identity
Inherited, see "Attributes" in User::Identity::Item
Extends "Collections" in Mail::Identity.
Inherited, see "Collections" in User::Identity::Item
Extends "Searching" in Mail::Identity.
Inherited, see "Searching" in User::Identity::Item
Character-set encoding, like 'q' and 'b', to be used when non-ascii characters are to be transmitted.
Returns an RFC compliant e-mail address, which will have character set encoding if needed. The objects are also overloaded to call this method in string context.
example:
print $address->string; print $address; # via overloading
The first argument is an object, but not of a class which extends User::Identity::Collection.
When addresses are specified to be included in header fields, they may be coerced into Mail::Message::Field::Address objects first. What you specify is not accepted as address specification. This may be an internal error.
Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname.
The $class did compile, but it was not possible to create an object of that class using the options you specified.
If you add a collection, it must either by a collection object or a list of options which can be used to create a collection object. In the latter case, the type of collection must be specified.
The collection with $name does not exist and can not be created.
This module is part of Mail-Message distribution version 3.005, built on December 22, 2017.
Do not forget to read Mail::Box-Overview, Mail::Box-Cookbook, and Mail::Box-Index. Examples are included in the Mail-Box distribution, directories 'examples' and 'scripts'.
Browseable manuals, papers, and other released material van be found at Website: http://perl.overmeer.net/mailbox/
The central modules (in separate distributions) in the MailBox suite are: Mail::Message, Mail::Box, Mail::Box::IMAP4, Mail::Box::POP3, Mail::Box::Parser::C, Mail::Box::Dbx (unpublished), Mail::Transport, Object::Realize::Later, and User::Identity.
Please post questions or ideas to the author markov@cpan.org.
Copyrights 2001-2017 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://dev.perl.org/licenses/
To install Mail::Message, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Message
CPAN shell
perl -MCPAN -e shell install Mail::Message
For more information on module installation, please visit the detailed CPAN module installation guide.