1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
=head1 NAME
Mail::Field::AddrList - object representation of e-mail address lists
=head1 INHERITANCE
Mail::Field::AddrList
is a Mail::Field
=head1 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');
=head1 DESCRIPTION
Defines parsing and formatting of address field, for the following
fields: C<To>, C<From>, C<Cc>, C<Reply-To>, and C<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 inderstood. Use Mail::Message::Field::Full
in MailBox if you need full RFC compliance.
=head1 METHODS
=head2 Constructors
Mail::Field::AddrList-E<gt>B<combine>(FIELDS)
=over 4
See L<Mail::Field/"Constructors">
=back
Mail::Field::AddrList-E<gt>B<extract>(TAG, HEAD [, INDEX ])
=over 4
See L<Mail::Field/"Constructors">
=back
Mail::Field::AddrList-E<gt>B<new>(TAG [, STRING | OPTIONS])
=over 4
See L<Mail::Field/"Constructors">
=back
=head2 "Fake" constructors
$obj-E<gt>B<create>(OPTIONS)
=over 4
See L<Mail::Field/""Fake" constructors">
=back
$obj-E<gt>B<parse>
=over 4
See L<Mail::Field/""Fake" constructors">
=back
=head2 Accessors
$obj-E<gt>B<set>(OPTIONS)
=over 4
See L<Mail::Field/"Accessors">
=back
$obj-E<gt>B<stringify>
=over 4
See L<Mail::Field/"Accessors">
=back
$obj-E<gt>B<tag>
Mail::Field::AddrList-E<gt>B<tag>
=over 4
See L<Mail::Field/"Accessors">
=back
=head2 Smart accessors
$obj-E<gt>B<addr_list>
=over 4
Returns the collected L<Mail::Address|Mail::Address> objects.
=back
$obj-E<gt>B<addresses>
=over 4
Returns a list if email addresses, found in the field content.
=back
$obj-E<gt>B<names>
=over 4
Returns a list of nicely formatted named, for each of the addresses
found in the content.
=back
$obj-E<gt>B<set_address>(EMAIL, NAME)
=over 4
Add/replace an EMAIL address to the field.
=back
$obj-E<gt>B<text>([STRING])
=over 4
See L<Mail::Field/"Smart accessors">
=back
=head1 DETAILS
=head1 DIAGNOSTICS
Error: Undefined subroutine <method> called
=over 4
Mail::Field objects use autoloading to compile new functionality.
Apparently, the mehod called is not implemented for the specific
class of the field object.
=back
=head1 SEE ALSO
This module is part of the MailTools distribution,
F<http://perl.overmeer.net/mailtools/>.
=head1 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 E<lt>aas@oslonett.noE<gt>.
Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
For other contributors see ChangeLog.
=head1 LICENSE
Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|
