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

DIAGNOSTICS

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

LICENSE

173       Copyrights 2003,2004,2007 by Mark Overmeer <perl@overmeer.net>.For
174       other contributors see Changes.
175
176       This program is free software; you can redistribute it and/or modify it
177       under the same terms as Perl itself.  See
178       http://www.perl.com/perl/misc/Artistic.html
179
180
181
182perl v5.8.8                       2007-01-U0s8er::Identity::Collection::Emails(3)