/ 
Mail-Box-2.090
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Field::Addresses

NAME

Mail::Message::Field::Addresses - Fields with e-mail addresses

INHERITANCE

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

SYNOPSIS

my $f = Mail::Message::Field->new(Cc =>
               'Mail::Box <mailbox@overmeer.net>');

my $cc = Mail::Message::Field->new('Cc');
$cc->addAddress('Mail::Box <mailbox@overmeer.net>');
$cc->addAddress
  ( phrase  => 'Mail::Box'
  , email   => 'mailbox@overmeer.net'
  , comment => 'Our mailing list'     # deprecated by RFC
  );

mu $ma = Mail::Message::Field::Address->new(...);
$cc->addAddress($ma);

my $mi = Mail::Identity->new(...);
$cc->addAddress($mi);

my $g  = Mail::Message::Field::AddrGroup->new(...);
$cc->addGroup($g);

DESCRIPTION

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.

OVERLOADED

overload: ""

overload: +0

overload: <=>

overload: bool

overload: cmp

overload: stringification

METHODS

Constructors

$obj->clone

Mail::Message::Field::Addresses->from(FIELD, OPTIONS)

Mail::Message::Field::Addresses->new

    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'

    . attributes => ATTRS

    . charset => STRING

    . datum => STRING

    . encoding => 'q'|'Q'|'b'|'B'

    . force => BOOLEAN

    . language => STRING

    . log => LEVEL

    . trace => LEVEL

The field

$obj->isStructured

Mail::Message::Field::Addresses->isStructured

$obj->length

$obj->nrLines

$obj->print([FILEHANDLE])

$obj->size

$obj->string([WRAP])

$obj->toDisclose

Access to the name

$obj->Name

$obj->name

$obj->wellformedName([STRING])

Access to the body

$obj->body

$obj->decodedBody(OPTIONS)

$obj->folded

$obj->foldedBody([BODY])

$obj->stripCFWS([STRING])

Mail::Message::Field::Addresses->stripCFWS([STRING])

$obj->unfoldedBody([BODY, [WRAP]])

Access to the content

$obj->addAddress([ADDRESS], OPTIONS)

    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   ''

    . group => STRING

$obj->addAttribute(...)

    Attributes are not supported for address fields.

$obj->addGroup(GROUP|OPTIONS)

    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    ''

    . name => STRING

$obj->addresses

    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;

$obj->attribute(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))

$obj->attributes

$obj->beautify

$obj->comment([STRING])

$obj->createComment(STRING, OPTIONS)

Mail::Message::Field::Addresses->createComment(STRING, OPTIONS)

$obj->createPhrase(STRING, OPTIONS)

Mail::Message::Field::Addresses->createPhrase(STRING, OPTIONS)

$obj->group(NAME)

    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.

$obj->groupNames

    Returns a list with all group names which are defined.

$obj->groups

$obj->study

$obj->toDate([TIME])

Mail::Message::Field::Addresses->toDate([TIME])

$obj->toInt

Other methods

$obj->dateToTimestamp(STRING)

Mail::Message::Field::Addresses->dateToTimestamp(STRING)

Internals

$obj->consume(LINE | (NAME,BODY|OBJECTS))

$obj->decode(STRING, OPTIONS)

Mail::Message::Field::Addresses->decode(STRING, OPTIONS)

$obj->defaultWrapLength([LENGTH])

$obj->encode(STRING, OPTIONS)

$obj->fold(NAME, BODY, [MAXCHARS])

Mail::Message::Field::Addresses->fold(NAME, BODY, [MAXCHARS])

$obj->setWrapLength([LENGTH])

$obj->stringifyData(STRING|ARRAY|OBJECTS)

$obj->unfold(STRING)

Parsing

$obj->consumeAddress(STRING, OPTIONS)

    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.

$obj->consumeComment(STRING)

Mail::Message::Field::Addresses->consumeComment(STRING)

$obj->consumeDomain(STRING)

    Try to get a valid domain representation from STRING. Returned are the domain string as found (or undef) and the rest of the string.

$obj->consumeDotAtom(STRING)

$obj->consumePhrase(STRING)

Mail::Message::Field::Addresses->consumePhrase(STRING)

$obj->datum([VALUE])

$obj->parse(STRING)

$obj->produceBody

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Field::Addresses->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Field::Addresses->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Message::Field::Addresses->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

DETAILS

DIAGNOSTICS

Warning: Field content is not numerical: $content

    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.

Warning: Illegal character in charset '$charset'

    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.

Warning: Illegal character in field name $name

    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.

Warning: Illegal character in language '$lang'

    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.

Warning: Illegal encoding '$encoding', used 'q'

    The RFCs only permit base64 (b or B ) or quoted-printable (q or Q) encoding. Other than these four options are illegal.

Error: No attributes for address fields.

    Is is not possible to add attributes to address fields: it is not permitted by the RFCs.

Error: Package $package does not implement $method.

    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.

SEE ALSO

This module is part of Mail-Box distribution version 2.090, built on June 02, 2009. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2009 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