/usr/share/perl5/Mail/Identity.pod is in libuser-identity-perl 0.93-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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | =head1 NAME
Mail::Identity - an e-mail role
=head1 INHERITANCE
Mail::Identity
is a User::Identity::Item
=head1 SYNOPSIS
use User::Identity;
use Mail::Identity;
my $me = User::Identity->new(...);
my $addr = Mail::Identity->new(address => 'x@y');
$me->add(email => $addr);
# Simpler
use User::Identity;
my $me = User::Identity->new(...);
my $addr = $me->add(email => 'x@y');
my $addr = $me->add( email => 'home'
, address => 'x@y');
# Conversion
my $ma = Mail::Address->new(...);
my $mi = Mail::Identity->coerce($ma);
=head1 DESCRIPTION
The C<Mail::Identity> object contains the description of role played by
a human when sending e-mail. Most people have more than one role these
days: for instance, a private and a company role with different e-mail
addresses.
An C<Mail::Identity> object combines an e-mail address, user description
("phrase"), a signature, pgp-key, and so on. All fields are optional,
and some fields are smart. One such set of data represents one role.
C<Mail::Identity> is therefore the smart cousine of the Mail::Address
object.
=head1 METHODS
=head2 Constructors
$obj-E<gt>B<from>(OBJECT)
=over 4
Convert an OBJECT into a C<Mail::Identity>. On the moment, you can
specify Mail::Address and L<User::Identity|User::Identity> objects. In the
former case, a new C<Mail::Identity> is created containing the same
information. In the latter, the first address of the user is picked
and returned.
=back
Mail::Identity-E<gt>B<new>([NAME], OPTIONS)
=over 4
Option --Defined in --Default
address <username@domain or name>
charset <user's charset>
comment <user's fullname if phrase is different>
description User::Identity::Item undef
domain <from email or localhost>
language <from user>
location <random user's location>
name User::Identity::Item <phrase or user's fullName>
organization <location's organization>
parent User::Identity::Item undef
pgp_key undef
phrase <user's fullName>
signature undef
username <from address or user's nickname>
. address => STRING
=over 4
The e-mail address is constructed from the username/domain, but
when both do not exist, the name is taken.
=back
. charset => STRING
. comment => STRING
. description => STRING
. domain => STRING
. language => STRING
. location => NAME|OBJECT
=over 4
The user's location which relates to this mail identity. This can be
specified as location name (which will be looked-up when needed), or
as L<User::Identity::Location|User::Identity::Location> object.
=back
. name => STRING
. organization => STRING
=over 4
Usually defined for e-mail addresses which are used by a company or
other organization, but less common for personal addresses. This
value will be used to fill the C<Organization> header field of messages.
=back
. parent => OBJECT
. pgp_key => STRING|FILENAME
. phrase => STRING
. signature => STRING
. username => STRING
=back
=head2 Constructors
=head2 Attributes
$obj-E<gt>B<address>
=over 4
Returns the e-mail address for this role. If none was specified, it will
be constructed from the username and domain. If those are not present
as well, then the L<name()|User::Identity::Item/"Attributes"> is used when it contains a C<@>, else the
user's nickname is taken.
=back
$obj-E<gt>B<charset>
=over 4
Returns the character set used in comment and phrase. When set to
C<undef>, the strings (are already encoded to) contain only ASCII
characters. This defaults to the value of the user's charset, if a user
is defined.
=back
$obj-E<gt>B<comment>([STRING])
=over 4
E-mail address -when included in message MIME headers- can contain a comment.
The RFCs advice not to store useful information in these comments, but it
you really want to, you can do it. The comment defaults to the user's
fullname if the phrase is not the fullname and there is a user defined.
Comments will be enclosed in parenthesis when used. Parenthesis (matching)
or non-matching) which are already in the string will carefully escaped
when needed. You do not need to worry.
=back
$obj-E<gt>B<description>
=over 4
See L<User::Identity::Item/"Attributes">
=back
$obj-E<gt>B<domain>
=over 4
The domain is the part of the e-mail address after the C<@>-sign.
When this is not defined, it can be deducted from the email address
(see L<address()|Mail::Identity/"Attributes">). If nothing is known, C<localhost> is returned.
=back
$obj-E<gt>B<language>
=over 4
Returns the language which is used for the description fields of this
e-mail address, which defaults to the user's language.
=back
$obj-E<gt>B<location>
=over 4
Returns the object which describes to which location this mail address relates.
The location may be used to find the name of the organization involved, or
to create a signature. If no location is specified, but a user is defined
which has locations, one of those is randomly chosen.
=back
$obj-E<gt>B<name>([NEWNAME])
=over 4
See L<User::Identity::Item/"Attributes">
=back
$obj-E<gt>B<organization>
=over 4
Returns the organization which relates to this e-mail identity. If not
explicitly specified, it is tried to be found via the location.
=back
$obj-E<gt>B<phrase>
=over 4
The phrase is used in an e-mail address to explain who is sending the
message. This usually is the fullname (the user's fullname is used by
default), description of your function (Webmaster), or any other text.
When an email string is produced, the phase will be quoted if needed.
Quotes which are within the string will automatically be escaped, so
you do no need to worry: input cannot break the outcome!
=back
$obj-E<gt>B<username>
=over 4
Returns the username of this e-mail address. If none is specified, first
it is tried to extract it from the specified e-mail address. If there is
also no username in the e-mail address, the user identity's nickname is
taken.
=back
=head2 Collections
$obj-E<gt>B<add>(COLLECTION, ROLE)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<collection>(NAME)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<find>(COLLECTION, ROLE)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<parent>([PARENT])
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<removeCollection>(OBJECT|NAME)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<type>
Mail::Identity-E<gt>B<type>
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<user>
=over 4
See L<User::Identity::Item/"Collections">
=back
=head1 DIAGNOSTICS
Error: $object is not a collection.
=over 4
The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.
=back
Error: Cannot load collection module for $type ($class).
=over 4
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.
=back
Error: Creation of a collection via $class failed.
=over 4
The $class did compile, but it was not possible to create an object
of that class using the options you specified.
=back
Error: Don't know what type of collection you want to add.
=over 4
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.
=back
Warning: No collection $name
=over 4
The collection with $name does not exist and can not be created.
=back
=head1 SEE ALSO
This module is part of User-Identity distribution version 0.93,
built on December 24, 2009. Website: F<http://perl.overmeer.net/userid/>
=head1 LICENSE
Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>. For other contributors see Changes.
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>
|