GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::FIELD::ADDRESSES (3)

.ds Aq ’

NAME

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

CONTENTS

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



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.

See documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>‘‘’’B>() See OVERLOADED in Mail::Message::Field
overload: <B>0+B>() See OVERLOADED in Mail::Message::Field
overload: <B><=B>>() See OVERLOADED in Mail::Message::Field
overload: <B>boolB>() See OVERLOADED in Mail::Message::Field
overload: <B>cmpB>() See OVERLOADED in Mail::Message::Field
overload: <B>stringificationB>() See OVERLOADED in Mail::Message::Field::Full

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>cloneB>() See Constructors in Mail::Message::Field
Mail::Message::Field::Addresses-><B>fromB>(FIELD, OPTIONS) See Constructors in Mail::Message::Field::Full
Mail::Message::Field::Addresses-><B>newB>()


 -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

See documentation in the base class.
$obj-><B>isStructuredB>()
Mail::Message::Field::Addresses-><B>isStructuredB>() See The field in Mail::Message::Field
$obj-><B>lengthB>() See The field in Mail::Message::Field
$obj-><B>nrLinesB>() See The field in Mail::Message::Field
$obj-><B>printB>([FILEHANDLE]) See The field in Mail::Message::Field
$obj-><B>sizeB>() See The field in Mail::Message::Field
$obj-><B>stringB>([WRAP]) See The field in Mail::Message::Field
$obj-><B>toDiscloseB>() See The field in Mail::Message::Field

    Access to the name

See documentation in the base class.
$obj-><B>NameB>() See Access to the name in Mail::Message::Field
$obj-><B>nameB>() See Access to the name in Mail::Message::Field
$obj-><B>wellformedNameB>([STRING]) See Access to the name in Mail::Message::Field

    Access to the body

See documentation in the base class.
$obj-><B>bodyB>() See Access to the body in Mail::Message::Field
$obj-><B>decodedBodyB>(OPTIONS) See Access to the body in Mail::Message::Field::Full
$obj-><B>foldedB>() See Access to the body in Mail::Message::Field
$obj-><B>foldedBodyB>([BODY]) See Access to the body in Mail::Message::Field
$obj-><B>stripCFWSB>([STRING])
Mail::Message::Field::Addresses-><B>stripCFWSB>([STRING]) See Access to the body in Mail::Message::Field
$obj-><B>unfoldedBodyB>([BODY, [WRAP]]) See Access to the body in Mail::Message::Field

    Access to the content

See documentation in the base class.
$obj-><B>addAddressB>([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-><B>addAttributeB>(...) Attributes are not supported for address fields.
$obj-><B>addGroupB>(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-><B>addressesB>() 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-><B>attrPairsB>() See Access to the content in Mail::Message::Field::Structured
$obj-><B>attributeB>(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS)) See Access to the content in Mail::Message::Field::Structured
$obj-><B>attributesB>() See Access to the content in Mail::Message::Field::Structured
$obj-><B>beautifyB>() See Access to the content in Mail::Message::Field::Full
$obj-><B>commentB>([STRING]) See Access to the content in Mail::Message::Field
$obj-><B>createCommentB>(STRING, OPTIONS)
Mail::Message::Field::Addresses-><B>createCommentB>(STRING, OPTIONS) See Access to the content in Mail::Message::Field::Full
$obj-><B>createPhraseB>(STRING, OPTIONS)
Mail::Message::Field::Addresses-><B>createPhraseB>(STRING, OPTIONS) See Access to the content in Mail::Message::Field::Full
$obj-><B>groupB>(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-><B>groupNamesB>() Returns a list with all group names which are defined.
$obj-><B>groupsB>() Returns all address groups which are defined in this field. Each element is a Mail::Message::Field::AddrGroup object.
$obj-><B>studyB>() See Access to the content in Mail::Message::Field
$obj-><B>toDateB>([TIME])
Mail::Message::Field::Addresses-><B>toDateB>([TIME]) See Access to the content in Mail::Message::Field
$obj-><B>toIntB>() See Access to the content in Mail::Message::Field

    Other methods

See documentation in the base class.
$obj-><B>dateToTimestampB>(STRING)
Mail::Message::Field::Addresses-><B>dateToTimestampB>(STRING) See Other methods in Mail::Message::Field

    Internals

See documentation in the base class.
$obj-><B>consumeB>(LINE | (NAME,BODY|OBJECTS)) See Internals in Mail::Message::Field
$obj-><B>decodeB>(STRING, OPTIONS)
Mail::Message::Field::Addresses-><B>decodeB>(STRING, OPTIONS) See Internals in Mail::Message::Field::Full
$obj-><B>defaultWrapLengthB>([LENGTH]) See Internals in Mail::Message::Field
$obj-><B>encodeB>(STRING, OPTIONS) See Internals in Mail::Message::Field::Full
$obj-><B>foldB>(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Addresses-><B>foldB>(NAME, BODY, [MAXCHARS]) See Internals in Mail::Message::Field
$obj-><B>setWrapLengthB>([LENGTH]) See Internals in Mail::Message::Field
$obj-><B>stringifyDataB>(STRING|ARRAY|OBJECTS) See Internals in Mail::Message::Field
$obj-><B>unfoldB>(STRING) See Internals in Mail::Message::Field

    Parsing

See documentation in the base class.
$obj-><B>consumeAddressB>(STRING, OPTIONS) Try to destilate address information from the STRING. Returned are an address <B>objectB> and the left-over string. If no address was found, the first returned value is undef.
$obj-><B>consumeCommentB>(STRING)
Mail::Message::Field::Addresses-><B>consumeCommentB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>consumeDomainB>(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-><B>consumeDotAtomB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>consumePhraseB>(STRING)
Mail::Message::Field::Addresses-><B>consumePhraseB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>datumB>([VALUE]) See Parsing in Mail::Message::Field::Structured
$obj-><B>parseB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>produceBodyB>() See Parsing in Mail::Message::Field::Full

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Field::Addresses-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Field::Addresses-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Field::Addresses-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DETAILS

See documentation in the base class.

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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::FIELD::ADDRESSES (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.