NAME

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

INHERITANCE

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

SYNOPSIS

DESCRIPTION

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

OVERLOADED

overload: @{}

See "OVERLOADED" in User::Identity::Collection

overload: stringification

See "OVERLOADED" in User::Identity::Collection

METHODS

Initiation

User::Identity::Collection::Emails->new([NAME], OPTIONS)

 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'>                     
 roles        L<User::Identity::Collection>  undef                           
 user         L<User::Identity::Collection>  undef                           

. description STRING

. item_type CLASS

. name STRING

. roles ROLE|ARRAY

. user OBJECT

Attributes

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

See "Attributes" in User::Identity::Collection

$obj->description

See "Attributes" in User::Identity::Item

$obj->name

See "Attributes" in User::Identity::Item

$obj->roles

See "Attributes" in User::Identity::Collection

$obj->user([USER])

See "Attributes" in User::Identity::Collection

Searching

$obj->find(NAME|CODE|undef)

See "Searching" in User::Identity::Collection

DIAGNOSTICS

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.

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.

REFERENCES

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

COPYRIGHTS

User::Identity version 0.05. 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.

cpanm User::Identity

perl -MCPAN -e shell
install User::Identity