OVERLOADED

overload: boolean

The object used as boolean will always return true

overload: string comparison

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

overload: stringification

When the object is used in string context, it will return the encoded representation of the e-mail address, just like string() does.

METHODS

Constructors

$obj->coerce( STRING|OBJECT, OPTIONS )

Try to coerce the OBJECT into a 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 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 Mail::Address, a Mail::Identity, or a User::Identity. In case of the latter, one of the user's addresses is chosen at random.

» Error: Cannot coerce a $type into a Mail::Message::Field::Address

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.

$class->new( [NAME], OPTIONS )
See new in Mail::Identity.
$obj->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.

Attributes

$obj->address
See address in Mail::Identity.
$obj->charset
See charset in Mail::Identity.
$obj->comment( [STRING] )
See comment in Mail::Identity.
$obj->description
See description in User::Identity::Item.
$obj->domain
See domain in Mail::Identity.
$obj->language
See language in Mail::Identity.
$obj->location
See location in Mail::Identity.
$obj->name( [NEWNAME] )
See name in User::Identity::Item.
$obj->organization
See organization in Mail::Identity.
$obj->phrase
See phrase in Mail::Identity.
$obj->username
See username in Mail::Identity.

Collections

$obj->add( COLLECTION, ROLE )
See add in User::Identity::Item.
$obj->addCollection( OBJECT | ([TYPE], OPTIONS) )
See addCollection in User::Identity::Item.
$obj->collection( NAME )
See collection in User::Identity::Item.
$obj->find( COLLECTION, ROLE )
See find in User::Identity::Item.
$obj->parent( [PARENT] )
See parent in User::Identity::Item.
$obj->removeCollection( OBJECT|NAME )
See removeCollection in User::Identity::Item.
$obj->type
$class->type
See type in User::Identity::Item.
$obj->user
See user in User::Identity::Item.

Accessors

$obj->encoding

Character-set encoding, like 'q' and 'b', to be used when non-ascii characters are to be transmitted.

Access to the content

$obj->string

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