Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
AddrGroup.pm	1.68 KB	-rw-r--r--
AddrGroup.pod	7.61 KB	-rw-r--r--
Address.pm	2.07 KB	-rw-r--r--
Address.pod	6.72 KB	-rw-r--r--
Addresses.pm	5.95 KB	-rw-r--r--
Addresses.pod	14.97 KB	-rw-r--r--
Attribute.pm	5.25 KB	-rw-r--r--
Attribute.pod	8.39 KB	-rw-r--r--
AuthResults.pm	5.3 KB	-rw-r--r--
AuthResults.pod	13.46 KB	-rw-r--r--
DKIM.pm	2.02 KB	-rw-r--r--
DKIM.pod	14.28 KB	-rw-r--r--
Date.pm	2.73 KB	-rw-r--r--
Date.pod	12.5 KB	-rw-r--r--
Fast.pm	2.03 KB	-rw-r--r--
Fast.pod	10.85 KB	-rw-r--r--
Flex.pm	2.59 KB	-rw-r--r--
Flex.pod	9.61 KB	-rw-r--r--
Full.pm	10.86 KB	-rw-r--r--
Full.pod	19.77 KB	-rw-r--r--
Structured.pm	3.53 KB	-rw-r--r--
Structured.pod	15.04 KB	-rw-r--r--
URIs.pm	1.73 KB	-rw-r--r--
URIs.pod	13.24 KB	-rw-r--r--
Unstructured.pm	1018 B	-rw-r--r--
Unstructured.pod	12.47 KB	-rw-r--r--

Code Editor : AddrGroup.pod

=encoding utf8

=head1 NAME

Mail::Message::Field::AddrGroup - A group of Mail::Message::Field::Address objects

=head1 INHERITANCE

Mail::Message::Field::AddrGroup
   is a User::Identity::Collection::Emails
   is a User::Identity::Collection
   is a User::Identity::Item

=head1 SYNOPSIS

my $g = Mail::Message::Field::AddrGroup->new(name => 'name');

my $a = Mail::Message::Field::Address->new(...);
 $g->addAddress($a);
 
 my $f = Mail::Message::Field::Addresses->new;
 $f->addGroup($g);

=head1 DESCRIPTION

An address group collects a set of e-mail addresses (in this case they
are L<Mail::Message::Field::Address|Mail::Message::Field::Address> objects).

Extends L<"DESCRIPTION" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"DESCRIPTION">.
 
=head1 OVERLOADED

Extends L<"OVERLOADED" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"OVERLOADED">.
 
=over 4

=item overload: B<@{}>

Inherited, see L<User::Identity::Collection/"OVERLOADED">

=item overload: B<stringification>

Returns the L<string()|Mail::Message::Field::AddrGroup/"METHODS"> value.

=item overload: B<stringification >

Inherited, see L<User::Identity::Collection/"OVERLOADED">

=back

=head1 METHODS

Extends L<"METHODS" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"METHODS">.
 
=over 4

=item $obj-E<gt>B<string>()

Returns the address group as string.  When no name is specified, it will
only be a comma separated list of addresses.  With a name, the groups
name will be prepended and a semi-colon appended.  When no addresses
where included and there is no name, then C<undef> is returned.

=back

=head2 Constructors

Extends L<"Constructors" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Constructors">.
 
=over 4

=item $obj-E<gt>B<coerce>($object)

Coerce an $object into a L<Mail::Message::Field::AddrGroup|Mail::Message::Field::AddrGroup>.  Currently,
you can only coerce L<User::Identity::Collection::Emails|User::Identity::Collection::Emails> (which is
the base class for this one) into this one.

=item Mail::Message::Field::AddrGroup-E<gt>B<new>( [$name], %options )

Inherited, see L<User::Identity::Collection::Emails/"Constructors">

=back

=head2 Attributes

Extends L<"Attributes" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Attributes">.
 
=over 4

=item $obj-E<gt>B<description>()

Inherited, see L<User::Identity::Item/"Attributes">

=item $obj-E<gt>B<itemType>()

Inherited, see L<User::Identity::Collection/"Attributes">

=item $obj-E<gt>B<name>( [$newname] )

Inherited, see L<User::Identity::Item/"Attributes">

=item $obj-E<gt>B<roles>()

Inherited, see L<User::Identity::Collection/"Attributes">

=back

=head2 Collections

Extends L<"Collections" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Collections">.
 
=over 4

=item $obj-E<gt>B<add>($collection, $role)