User::Identity::Collection::Emails(3pm)

1User::Identity::CollectUisoenr::CEomnatirlisb(u3t)ed PerUlseDro:c:uImdeennttaittiyo:n:Collection::Emails(3)
2
3
4

NAME

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

INHERITANCE

9        User::Identity::Collection::Emails
10          is a User::Identity::Collection
11          is a User::Identity::Item
12

SYNOPSIS

DESCRIPTION

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

OVERLOADED

20       overload: @{}
21
22           See "OVERLOADED" in User::Identity::Collection
23
24       overload: stringification
25
26           See "OVERLOADED" in User::Identity::Collection
27

METHODS

29   Constructors
30       User::Identity::Collection::Emails->new([NAME], OPTIONS)
31
32        Option     --Defined in     --Default
33        description  User::Identity::Item  undef
34        item_type    User::Identity::Collection  Mail::Identity
35        name         User::Identity::Item  'emails'
36        parent       User::Identity::Item  undef
37        roles        User::Identity::Collection  undef
38
39           . description => STRING
40
41           . item_type => CLASS
42
43           . name => STRING
44
45           . parent => OBJECT
46
47           . roles => ROLE|ARRAY
48
49   Attributes
50       $obj->description
51
52           See "Attributes" in User::Identity::Item
53
54       $obj->itemType
55
56           See "Attributes" in User::Identity::Collection
57
58       $obj->name([NEWNAME])
59
60           See "Attributes" in User::Identity::Item
61
62       $obj->roles
63
64           See "Attributes" in User::Identity::Collection
65
66   Collections
67       $obj->add(COLLECTION, ROLE)
68
69           See "Collections" in User::Identity::Item
70
71       $obj->addCollection(OBJECT | ([TYPE], OPTIONS))
72
73           See "Collections" in User::Identity::Item
74
75       $obj->collection(NAME)
76
77           See "Collections" in User::Identity::Item
78
79       $obj->parent([PARENT])
80
81           See "Collections" in User::Identity::Item
82
83       $obj->removeCollection(OBJECT|NAME)
84
85           See "Collections" in User::Identity::Item
86
87       $obj->type
88
89       User::Identity::Collection::Emails->type
90
91           See "Collections" in User::Identity::Item
92
93       $obj->user
94
95           See "Collections" in User::Identity::Item
96
97   Maintaining roles
98       $obj->addRole(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS)
99
100           See "Maintaining roles" in User::Identity::Collection
101
102       $obj->removeRole(ROLE|NAME)
103
104           See "Maintaining roles" in User::Identity::Collection
105
106       $obj->renameRole(ROLE|OLDNAME, NEWNAME)
107
108           See "Maintaining roles" in User::Identity::Collection
109
110       $obj->sorted
111
112           See "Maintaining roles" in User::Identity::Collection
113
114   Searching
115       $obj->find(NAME|CODE|undef)
116
117           See "Searching" in User::Identity::Collection
118

DIAGNOSTICS

120       Error: $object is not a collection.
121
122           The first argument is an object, but not of a class which extends
123           User::Identity::Collection.
124
125       Error: Cannot create a $type to add this to my collection.
126
127           Some options are specified to create a $type object, which is
128           native to this collection.  However, for some reason this failed.
129
130       Error: Cannot load collection module for $type ($class).
131
132           Either the specified $type does not exist, or that module named
133           $class returns compilation errors.  If the type as specified in the
134           warning is not the name of a package, you specified a nickname
135           which was not defined.  Maybe you forgot the 'require' the package
136           which defines the nickname.
137
138       Error: Cannot rename $name into $newname: already exists
139
140       Error: Cannot rename $name into $newname: doesn't exist
141
142       Error: Creation of a collection via $class failed.
143
144           The $class did compile, but it was not possible to create an object
145           of that class using the options you specified.
146
147       Error: Don't know what type of collection you want to add.
148
149           If you add a collection, it must either by a collection object or a
150           list of options which can be used to create a collection object.
151           In the latter case, the type of collection must be specified.
152
153       Warning: No collection $name
154
155           The collection with $name does not exist and can not be created.
156
157       Error: Wrong type of role for $collection: requires a $expect but got a
158       $type
159
160           Each $collection groups sets of roles of one specific type
161           ($expect).  You cannot add objects of a different $type.
162

LICENSE

168       Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>.
169       For other contributors see Changes.
170
171       This program is free software; you can redistribute it and/or modify it
172       under the same terms as Perl itself.  See
173       http://www.perl.com/perl/misc/Artistic.html
174
175
176
177perl v5.12.1                      2009-12-U2s4er::Identity::Collection::Emails(3)