NAME
Mail::Message::Field::Address - One e-mail address
INHERITANCE
Mail::Message::Field::Address
is a Mail::Identity
is a User::Identity::Collection::Item
is a User::Identity::ItemSYNOPSIS
my $addr = Mail::Message::Field::Address->new(...);
my $ui = User::Idenity->new(...);
my $addr = Mail::Message::Field::Address->coerce($ui);
my $mi = Mail::Idenity->new(...);
my $addr = Mail::Message::Field::Address->coerce($mi);
print $addr->address;
print $addr->fullName; # possibly unicode!
print $addr->domain;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.
OVERLOADED
overload: boolean
The object used as boolean will always return true
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
Initiation
$obj->from(OBJECT)
Mail::Message::Field::Address->new([NAME], OPTIONS)
Attributes
$obj->address
$obj->charset
$obj->comment([STRING])
$obj->description
$obj->domain
$obj->language
$obj->location
$obj->name
$obj->organization
$obj->phrase
$obj->user([USER])
$obj->username
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.
$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.
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 overloadingDIAGNOSTICS
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.
REFERENCES
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Distribution version 2.046. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.