Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
AddrGroup.pm	1.68 KB	-rw-r--r--
AddrGroup.pod	7.61 KB	-rw-r--r--
Address.pm	2.07 KB	-rw-r--r--
Address.pod	6.72 KB	-rw-r--r--
Addresses.pm	5.95 KB	-rw-r--r--
Addresses.pod	14.97 KB	-rw-r--r--
Attribute.pm	5.25 KB	-rw-r--r--
Attribute.pod	8.39 KB	-rw-r--r--
AuthResults.pm	5.3 KB	-rw-r--r--
AuthResults.pod	13.46 KB	-rw-r--r--
DKIM.pm	2.02 KB	-rw-r--r--
DKIM.pod	14.28 KB	-rw-r--r--
Date.pm	2.73 KB	-rw-r--r--
Date.pod	12.5 KB	-rw-r--r--
Fast.pm	2.03 KB	-rw-r--r--
Fast.pod	10.85 KB	-rw-r--r--
Flex.pm	2.59 KB	-rw-r--r--
Flex.pod	9.61 KB	-rw-r--r--
Full.pm	10.86 KB	-rw-r--r--
Full.pod	19.77 KB	-rw-r--r--
Structured.pm	3.53 KB	-rw-r--r--
Structured.pod	15.04 KB	-rw-r--r--
URIs.pm	1.73 KB	-rw-r--r--
URIs.pod	13.24 KB	-rw-r--r--
Unstructured.pm	1018 B	-rw-r--r--
Unstructured.pod	12.47 KB	-rw-r--r--

Code Editor : Address.pod

=encoding utf8

=head1 NAME

Mail::Message::Field::Address - One e-mail address

=head1 INHERITANCE

Mail::Message::Field::Address
   is a Mail::Identity
   is a User::Identity::Item

=head1 SYNOPSIS

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;

=head1 DESCRIPTION

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 L<"DESCRIPTION" in Mail::Identity|Mail::Identity/"DESCRIPTION">.
 
=head1 OVERLOADED

=over 4

=item overload: B<boolean>

The object used as boolean will always return C<true>

=item overload: B<string $comparison>

Two address objects are the same when their email addresses are the
same.

=item overload: B<stringification>

When the object is used in string context, it will return the encoded
representation of the e-mail address, just like L<string()|Mail::Message::Field::Address/"Access to the content"> does.

=back

=head1 METHODS

Extends L<"METHODS" in Mail::Identity|Mail::Identity/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Identity|Mail::Identity/"Constructors">.
 
=over 4

=item $obj-E<gt>B<coerce>( <STRING|$object>, %options )

Try to coerce the $object into a C<Mail::Message::Field::Address>.
In case of a STRING, it is interpreted as an email address.

The %options are passed to the object creation, and overrule the values
found in the $object.  The result may be C<undef> or a newly created
object.  If the $object is already of the correct type, it is returned
unmodified.

The $object may currently be a L<Mail::Address|Mail::Address>, a L<Mail::Identity|Mail::Identity>, or
a L<User::Identity|User::Identity>.  In case of the latter, one of the user's addresses
is chosen at random.

=item Mail::Message::Field::Address-E<gt>B<new>( [$name], %options )

Inherited, see L<Mail::Identity/"Constructors">

=item $obj-E<gt>B<parse>(STRING)

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.

=back

=head2 Attributes

Extends L<"Attributes" in Mail::Identity|Mail::Identity/"Attributes">.
 
=over 4

=item $obj-E<gt>B<address>()