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::FIELD::ADDRLIST (3)

.ds Aq ’

NAME

Mail::Field::AddrList - object representation of e-mail address lists

CONTENTS

INHERITANCE



 Mail::Field::AddrList
   is a Mail::Field



SYNOPSIS



  use Mail::Field::AddrList;

  $to   = Mail::Field->new(To);
  $from = Mail::Field->new(From, poe@daimi.aau.dk (Peter Orbaek));
 
  $from->create(foo@bar.com => Mr. Foo, poe => Peter);
  $from->parse(foo@bar.com (Mr Foo), Peter Orbaek <poe>);

  # make a RFC822 header string
  print $from->stringify(),"\n";

  # extract e-mail addresses and names
  @addresses = $from->addresses(); # strings
  @names     = $from->names();     # strings
  @addr      = $from->addr_list(); # Mail::Address objects (v2.00)

  # adjoin a new address to the list
  $from->set_address(foo@bar.com, Mr. Foo);



DESCRIPTION

Defines parsing and formatting of address field, for the following fields: To, From, Cc, Reply-To, and Sender.

All the normally used features of the address field specification of RFC2822 are implemented, but some complex (and therefore hardly ever used) constructs will not be understood. Use Mail::Message::Field::Full in MailBox if you need full RFC compliance.

Extends DESCRIPTION in Mail::Field.

METHODS

Extends METHODS in Mail::Field.

    Constructors

Extends Constructors in Mail::Field.
Mail::Field::AddrList-><B>combineB>(FIELDS) Inherited, see Constructors in Mail::Field
Mail::Field::AddrList-><B>extractB>( TAG, HEAD [, INDEX ] ) Inherited, see Constructors in Mail::Field
Mail::Field::AddrList-><B>newB>( TAG [, STRING | OPTIONS] ) Inherited, see Constructors in Mail::Field

    ‘‘Fake’’ constructors

Extends "Fake constructors" in Mail::Field.
$obj-><B>createB>(OPTIONS) Inherited, see "Fake constructors" in Mail::Field
$obj-><B>parseB>() Inherited, see "Fake constructors" in Mail::Field

    Accessors

Extends Accessors in Mail::Field.
$obj-><B>setB>(OPTIONS) Inherited, see Accessors in Mail::Field
$obj-><B>stringifyB>() Inherited, see Accessors in Mail::Field
$obj-><B>tagB>()
Mail::Field::AddrList-><B>tagB>() Inherited, see Accessors in Mail::Field

    Smart accessors

Extends Smart accessors in Mail::Field.
$obj-><B>addr_listB>() Returns the collected Mail::Address objects.
$obj-><B>addressesB>() Returns a list if email addresses, found in the field content.
$obj-><B>namesB>() Returns a list of nicely formatted named, for each of the addresses found in the content.
$obj-><B>set_addressB>(EMAIL, NAME) Add/replace an EMAIL address to the field.
$obj-><B>textB>( [STRING] ) Inherited, see Smart accessors in Mail::Field

DETAILS

Extends DETAILS in Mail::Field.

DIAGNOSTICS

Error: Undefined subroutine <method> called Mail::Field objects use autoloading to compile new functionality. Apparently, the method called is not implemented for the specific class of the field object.

SEE ALSO

This module is part of the MailTools distribution, http://perl.overmeer.net/mailtools/.

AUTHORS

The MailTools bundle was developed by Graham Barr. Later, Mark Overmeer took over maintenance without commitment to further development.

Mail::Cap by Gisle Aas <aas@oslonett.no>. Mail::Field::AddrList by Peter Orbaek <poe@cit.dk>. Mail::Mailer and Mail::Send by Tim Bunce <Tim.Bunce@ig.co.uk>. For other contributors see ChangeLog.

LICENSE

Copyrights 1995-2000 Graham Barr <gbarr@pobox.com> and 2001-2007 Mark Overmeer <perl@overmeer.net>.

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::FIELD::ADDRLIST (3) 2014-11-21

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