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

 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

  my $cc = Mail::Message::Field::Full->new('Cc');
  my $me = Mail::Message::Field::Address->parse('"Test" <test@mail.box>')
     or die;

  my $other = Mail::Message::Field::Address->new(phrase => 'Other'
     , address => 'other@example.com')
     or die;

  $cc->addAddress($me);
  $cc->addAddress($other, group => 'them');
  $cc->addAddress(phrase => 'third', address => 'more@any.museum'
    , group => 'them');

  my $group = $cc->addGroup(name => 'collegues');
  $group->addAddress($me);
  $group->addAddress(phrase => "You", address => 'you@example.com');

  my $msg = Mail::Message->build(Cc => $cc);
  print $msg->string;

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

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.

overload: ""

See "OVERLOADED" in Mail::Message::Field

overload: +0

See "OVERLOADED" in Mail::Message::Field

overload: <=>

See "OVERLOADED" in Mail::Message::Field

overload: bool

See "OVERLOADED" in Mail::Message::Field

overload: cmp

See "OVERLOADED" in Mail::Message::Field

overload: stringification

See "OVERLOADED" in Mail::Message::Field::Full

$obj->clone

See "Constructors" in Mail::Message::Field

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

See "Constructors" in Mail::Message::Field::Full

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

$obj->isStructured

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

See "The field" in Mail::Message::Field

$obj->length

See "The field" in Mail::Message::Field

$obj->nrLines

See "The field" in Mail::Message::Field

$obj->print([FILEHANDLE])

See "The field" in Mail::Message::Field

$obj->size

See "The field" in Mail::Message::Field

$obj->string([WRAP])

See "The field" in Mail::Message::Field

$obj->toDisclose

See "The field" in Mail::Message::Field

$obj->Name

See "Access to the name" in Mail::Message::Field

$obj->name

See "Access to the name" in Mail::Message::Field

$obj->wellformedName([STRING])

See "Access to the name" in Mail::Message::Field

$obj->body

See "Access to the body" in Mail::Message::Field

$obj->decodedBody(OPTIONS)

See "Access to the body" in Mail::Message::Field::Full

$obj->folded

See "Access to the body" in Mail::Message::Field

$obj->foldedBody([BODY])

See "Access to the body" in Mail::Message::Field

$obj->stripCFWS([STRING])

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

See "Access to the body" in Mail::Message::Field

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

See "Access to the body" in Mail::Message::Field

$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))

See "Access to the content" in Mail::Message::Field::Structured

$obj->attributes

See "Access to the content" in Mail::Message::Field::Structured

$obj->beautify

See "Access to the content" in Mail::Message::Field::Full

$obj->comment([STRING])

See "Access to the content" in Mail::Message::Field

$obj->createComment(STRING, OPTIONS)

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

See "Access to the content" in Mail::Message::Field::Full

$obj->createPhrase(STRING, OPTIONS)

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

See "Access to the content" in Mail::Message::Field::Full

$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

Returns all address groups which are defined in this field. Each element is a Mail::Message::Field::AddrGroup object.

$obj->study

See "Access to the content" in Mail::Message::Field

$obj->toDate([TIME])

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

See "Access to the content" in Mail::Message::Field

$obj->toInt

See "Access to the content" in Mail::Message::Field

$obj->dateToTimestamp(STRING)

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

See "Other methods" in Mail::Message::Field

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

See "Internals" in Mail::Message::Field

$obj->decode(STRING, OPTIONS)

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

See "Internals" in Mail::Message::Field::Full

$obj->defaultWrapLength([LENGTH])

See "Internals" in Mail::Message::Field

$obj->encode(STRING, OPTIONS)

See "Internals" in Mail::Message::Field::Full

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

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

See "Internals" in Mail::Message::Field

$obj->setWrapLength([LENGTH])

See "Internals" in Mail::Message::Field

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

See "Internals" in Mail::Message::Field

$obj->unfold(STRING)

See "Internals" in Mail::Message::Field

$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)

See "Parsing" in Mail::Message::Field::Full

$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)

See "Parsing" in Mail::Message::Field::Full

$obj->consumePhrase(STRING)

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

See "Parsing" in Mail::Message::Field::Full

$obj->datum([VALUE])

See "Parsing" in Mail::Message::Field::Structured

$obj->parse(STRING)

See "Parsing" in Mail::Message::Field::Full

$obj->produceBody

See "Parsing" in Mail::Message::Field::Full

$obj->AUTOLOAD

See "Error handling" in Mail::Reporter

$obj->addReport(OBJECT)

See "Error handling" in Mail::Reporter

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

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

See "Error handling" in Mail::Reporter

$obj->errors

See "Error handling" in Mail::Reporter

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

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

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)

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

See "Error handling" in Mail::Reporter

$obj->logSettings

See "Error handling" in Mail::Reporter

$obj->notImplemented

See "Error handling" in Mail::Reporter

$obj->report([LEVEL])

See "Error handling" in Mail::Reporter

$obj->reportAll([LEVEL])

See "Error handling" in Mail::Reporter

$obj->trace([LEVEL])

See "Error handling" in Mail::Reporter

$obj->warnings

See "Error handling" in Mail::Reporter

$obj->DESTROY

See "Cleanup" in Mail::Reporter

$obj->inGlobalDestruction

See "Cleanup" in Mail::Reporter

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.

This module is part of Mail-Box distribution version 2.098, built on March 17, 2011. Website: http://perl.overmeer.net/mailbox/

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