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
19       Extends "DESCRIPTION" in User::Identity::Collection.
20

OVERLOADED

22       Extends "OVERLOADED" in User::Identity::Collection.
23
24       overload: @{}
25           Inherited, see "OVERLOADED" in User::Identity::Collection
26
27       overload: stringification
28           Inherited, see "OVERLOADED" in User::Identity::Collection
29

METHODS

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

DIAGNOSTICS

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

LICENSE

151       Copyrights 2003-2023 by [Mark Overmeer <markov@cpan.org>]. For other
152       contributors see ChangeLog.
153
154       This program is free software; you can redistribute it and/or modify it
155       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
156
157
158
159perl v5.36.1                      2023-04-U3s0er::Identity::Collection::Emails(3)