/usr/share/perl5/Mail/Message/Field/Address.pod is in libmail-message-perl 3.006-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 | =encoding utf8
=head1 NAME
Mail::Message::Field::Address - One e-mail address
=head1 INHERITANCE
Mail::Message::Field::Address
is a Mail::Identity
is an User::Identity::Item
=head1 SYNOPSIS
my $addr = Mail::Message::Field::Address->new(...);
my $ui = User::Identity->new(...);
my $addr = Mail::Message::Field::Address->coerce($ui);
my $mi = Mail::Identity->new(...);
my $addr = Mail::Message::Field::Address->coerce($mi);
print $addr->address;
print $addr->fullName; # possibly unicode!
print $addr->domain;
=head1 DESCRIPTION
Many header fields can contain e-mail addresses. Each e-mail address
can be represented by an object of this class. These objects will
handle interpretation and character set encoding and decoding for you.
Extends L<"DESCRIPTION" in Mail::Identity|Mail::Identity/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
=item overload: B<boolean>
The object used as boolean will always return C<true>
=item overload: B<string $comparison>
Two address objects are the same when their email addresses are the
same.
=item overload: B<stringification>
When the object is used in string context, it will return the encoded
representation of the e-mail address, just like L<string()|Mail::Message::Field::Address/"Access to the content"> does.
=back
=head1 METHODS
Extends L<"METHODS" in Mail::Identity|Mail::Identity/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Identity|Mail::Identity/"Constructors">.
=over 4
=item $obj-E<gt>B<coerce>( <STRING|$object>, %options )
Try to coerce the $object into a C<Mail::Message::Field::Address>.
In case of a STRING, it is interpreted as an email address.
The %options are passed to the object creation, and overrule the values
found in the $object. The result may be C<undef> or a newly created
object. If the $object is already of the correct type, it is returned
unmodified.
The $object may currently be a L<Mail::Address|Mail::Address>, a L<Mail::Identity|Mail::Identity>, or
a L<User::Identity|User::Identity>. In case of the latter, one of the user's addresses
is chosen at random.
=item Mail::Message::Field::Address-E<gt>B<new>( [$name], %options )
Inherited, see L<Mail::Identity/"Constructors">
=item $obj-E<gt>B<parse>(STRING)
Parse the string for an address. You never know whether one or more
addresses are specified on a line (often applications are wrong), therefore,
the STRING is first parsed for as many addresses as possible and then the
one is taken at random.
=back
=head2 Attributes
Extends L<"Attributes" in Mail::Identity|Mail::Identity/"Attributes">.
=over 4
=item $obj-E<gt>B<address>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<charset>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<comment>( [STRING] )
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<description>()
Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<domain>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<language>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<location>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<name>( [$newname] )
Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<organization>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<phrase>()
Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<username>()
Inherited, see L<Mail::Identity/"Attributes">
=back
=head2 Collections
Extends L<"Collections" in Mail::Identity|Mail::Identity/"Collections">.
=over 4
=item $obj-E<gt>B<add>($collection, $role)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>( $object | <[$type], %options> )
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>($name)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<parent>( [$parent] )
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>($object|$name)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<type>()
=item Mail::Message::Field::Address-E<gt>B<type>()
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
Inherited, see L<User::Identity::Item/"Collections">
=back
=head2 Searching
Extends L<"Searching" in Mail::Identity|Mail::Identity/"Searching">.
=over 4
=item $obj-E<gt>B<find>($collection, $role)
Inherited, see L<User::Identity::Item/"Searching">
=back
=head2 Accessors
=over 4
=item $obj-E<gt>B<encoding>()
Character-set encoding, like 'q' and 'b', to be used when non-ascii
characters are to be transmitted.
=back
=head2 Access to the content
=over 4
=item $obj-E<gt>B<string>()
Returns an RFC compliant e-mail address, which will have character
set encoding if needed. The objects are also overloaded to call
this method in string context.
example:
print $address->string;
print $address; # via overloading
=back
=head1 DIAGNOSTICS
=over 4
=item Error: $object is not a collection.
The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.
=item Error: Cannot coerce a $type into a Mail::Message::Field::Address
When addresses are specified to be included in header fields, they may
be coerced into L<Mail::Message::Field::Address|Mail::Message::Field::Address> objects first. What
you specify is not accepted as address specification. This may be an
internal error.
=item Error: Cannot load collection module for $type ($class).
Either the specified $type does not exist, or that module named $class returns
compilation errors. If the type as specified in the warning is not
the name of a package, you specified a nickname which was not defined.
Maybe you forgot the 'require' the package which defines the nickname.
=item Error: Creation of a collection via $class failed.
The $class did compile, but it was not possible to create an object
of that class using the options you specified.
=item Error: Don't know what type of collection you want to add.
If you add a collection, it must either by a collection object or a
list of options which can be used to create a collection object. In
the latter case, the type of collection must be specified.
=item Warning: No collection $name
The collection with $name does not exist and can not be created.
=back
=head1 SEE ALSO
This module is part of Mail-Message distribution version 3.006,
built on January 24, 2018. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
Copyrights 2001-2018 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 F<http://dev.perl.org/licenses/>
|