
=head1 NAME

User::Identity::Collection::Emails - a collection of email roles


=head1 INHERITANCE

 User::Identity::Collection::Emails
   is a User::Identity::Collection
   is a User::Identity::Item


=head1 SYNOPSIS



=head1 DESCRIPTION

The C<User::Identity::Collection::Emails> object maintains a set
L<Mail::Identity|Mail::Identity> objects, each describing a role which the user has
in e-mail traffic.


=head1 OVERLOADED


overload: B<@{}>

=over 4

See L<User::Identity::Collection/"OVERLOADED">

=back

overload: B<stringification>

=over 4

See L<User::Identity::Collection/"OVERLOADED">

=back


=head1 METHODS


=head2 Constructors


User::Identity::Collection::Emails-E<gt>B<new>([NAME], OPTIONS)

=over 4

 Option       Defined in       Default                         
 description  L<User::Identity::Item>  undef                           
 item_type    L<User::Identity::Collection>  L<Mail::Identity|Mail::Identity>
 name         L<User::Identity::Item>  C<'emails'>                     
 parent       L<User::Identity::Item>  C<undef>                        
 roles        L<User::Identity::Collection>  undef                           

. description STRING

. item_type CLASS

. name STRING

. parent OBJECT

. roles ROLE|ARRAY

=back

=head2 Attributes


$obj-E<gt>B<description>

=over 4

See L<User::Identity::Item/"Attributes">

=back

$obj-E<gt>B<itemType>

=over 4

See L<User::Identity::Collection/"Attributes">

=back

$obj-E<gt>B<name>([NEWNAME])

=over 4

See L<User::Identity::Item/"Attributes">

=back

$obj-E<gt>B<roles>

=over 4

See L<User::Identity::Collection/"Attributes">

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

User::Identity::Collection::Emails-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

=head2 Maintaining roles


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

=over 4

See L<User::Identity::Collection/"Maintaining roles">

=back

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

=over 4

See L<User::Identity::Collection/"Maintaining roles">

=back

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

=over 4

See L<User::Identity::Collection/"Maintaining roles">

=back

$obj-E<gt>B<sorted>

=over 4

See L<User::Identity::Collection/"Maintaining roles">

=back

=head2 Searching


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

=over 4

See L<User::Identity::Collection/"Searching">

=back



=head1 DIAGNOSTICS

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

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

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

I<Error:> Cannot rename $name into $newname: already exists


I<Error:> Cannot rename $name into $newname: doesn't exist


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

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

I<Warning:> No collection $name

The collection with $name does not exist and can not be created.

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






=head1 REFERENCES

See the User::Identity website at L<http://perl.overmeer.net/userid/> for more details.

=head1 COPYRIGHTS

User::Identity version 0.90.
Written by Mark Overmeer (mark@overmeer.net).  See the ChangeLog for
other contributors.

Copyright (c) 2003 by the author(s). All rights reserved.  This program
is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.


