=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.

=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)

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::AddrGroup-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 Maintaining roles

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

=item $obj-E<gt>B<addRole>(ROLE| ([NAME],OPTIONS) | ARRAY)

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

=item $obj-E<gt>B<removeRole>(ROLE|NAME)

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

=item $obj-E<gt>B<renameRole>( <ROLE|OLDNAME>, NEWNAME )

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

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

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

=back

=head2 Searching

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

=item $obj-E<gt>B<find>(NAME|CODE|undef)

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

=back

=head2 Addresses

=over 4

=item $obj-E<gt>B<addAddress>(STRING|$address|%options)

Add one e-mail address to the list which is maintained in the group. This
is a wrapper around L<addRole()|User::Identity::Collection/"Maintaining roles"> adding flexibility on how addresses
are specified.  An $address can be anything which is acceptable for
L<Mail::Message::Field::Address::coerce()|Mail::Message::Field::Address/"Constructors"> or a list of options which
will create such an object.

example: of adding an address to an address group

 my @data = (full_name => "Myself", address => 'me@tux.org');
 $group->addAddress(@data);

 my $addr = Mail::Message::Field::Address->new(@data);
 $group->addAddress(@data);

 my $ma = Mail::Address->new(...);
 $group->addAddress($ma);

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

Returns all addresses defined in this group.  The addresses will be
ordered alphabetically to make automated testing possible: roles are
stored in a hash, so have an unpredictable order by default.

example: getting all addresses from a group

 my @addrs = $group->addresses;
 my @addrs = map { $_->address } $self->roles; #same

=back

=head2 Error handling

=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::AddrGroup

=item Error: Cannot create a $type to add this to my collection.

Some options are specified to create a $type object, which is native to
this collection.  However, for some reason this failed.

=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: Cannot rename $name into $newname: already exists

=item Error: Cannot rename $name into $newname: doesn't exist

=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.

=item Error: Wrong type of role for $collection: requires a $expect but got a $type

Each $collection groups sets of roles of one specific type ($expect).  You
cannot add objects of a different $type.

=back

=head1 SEE ALSO

This module is part of Mail-Box distribution version 2.118,
built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>

=head1 LICENSE

Copyrights 2001-2015 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://www.perl.com/perl/misc/Artistic.html>

