1Mail::Box::Collection(3U)ser Contributed Perl DocumentatiMoanil::Box::Collection(3)
2
3
4
6 Mail::Box::Collection - a collection of subfolders
7
9 Mail::Box::Collection
10 is an User::Identity::Collection
11 is an User::Identity::Item
12
13 Mail::Box::Collection
14 is a Mail::Reporter
15
18 The Mail::Box::Collection object maintains a set Mail::Box::Identity
19 objects, each describing a the location of a single mailbox (folder).
20 The collection is used by the Mail::Box::Manage::User object to
21 administer the folders of a single user, even if those folders are
22 closed.
23
24 Extends "DESCRIPTION" in Mail::Reporter.
25
26 Extends "DESCRIPTION" in User::Identity::Collection.
27
29 Extends "OVERLOADED" in User::Identity::Collection.
30
31 overload: @{}
32 Inherited, see "OVERLOADED" in User::Identity::Collection
33
34 overload: stringification
35 Inherited, see "OVERLOADED" in User::Identity::Collection
36
38 Extends "METHODS" in Mail::Reporter.
39
40 Extends "METHODS" in User::Identity::Collection.
41
42 Constructors
43 Extends "Constructors" in Mail::Reporter.
44
45 Extends "Constructors" in User::Identity::Collection.
46
47 Mail::Box::Collection->new( [$name], %options )
48 -Option --Defined in --Default
49 description User::Identity::Item undef
50 folder_type <from parent>
51 item_type User::Identity::Collection Mail::Box::Identity
52 log Mail::Reporter 'WARNINGS'
53 manager <from parent>
54 name User::Identity::Item 'folders'
55 parent User::Identity::Item undef
56 roles User::Identity::Collection undef
57 trace Mail::Reporter 'WARNINGS'
58
59 description => STRING
60 folder_type => CLASS
61 item_type => CLASS
62 log => LEVEL
63 manager => OBJECT
64 An Mail::Box::Manager OBJECT (could be a
65 Mail::Box::Manage::User).
66
67 name => STRING
68 parent => OBJECT
69 roles => ROLE|ARRAY
70 trace => LEVEL
71
72 Error handling
73 Extends "Error handling" in Mail::Reporter.
74
75 $obj->AUTOLOAD()
76 Inherited, see "Error handling" in Mail::Reporter
77
78 $obj->addReport($object)
79 Inherited, see "Error handling" in Mail::Reporter
80
81 $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
82 $callback] )
83 Mail::Box::Collection->defaultTrace( [$level]|[$loglevel,
84 $tracelevel]|[$level, $callback] )
85 Inherited, see "Error handling" in Mail::Reporter
86
87 $obj->errors()
88 Inherited, see "Error handling" in Mail::Reporter
89
90 $obj->log( [$level, [$strings]] )
91 Mail::Box::Collection->log( [$level, [$strings]] )
92 Inherited, see "Error handling" in Mail::Reporter
93
94 $obj->logPriority($level)
95 Mail::Box::Collection->logPriority($level)
96 Inherited, see "Error handling" in Mail::Reporter
97
98 $obj->logSettings()
99 Inherited, see "Error handling" in Mail::Reporter
100
101 $obj->notImplemented()
102 Inherited, see "Error handling" in Mail::Reporter
103
104 $obj->report( [$level] )
105 Inherited, see "Error handling" in Mail::Reporter
106
107 $obj->reportAll( [$level] )
108 Inherited, see "Error handling" in Mail::Reporter
109
110 $obj->trace( [$level] )
111 Inherited, see "Error handling" in Mail::Reporter
112
113 $obj->warnings()
114 Inherited, see "Error handling" in Mail::Reporter
115
116 Cleanup
117 Extends "Cleanup" in Mail::Reporter.
118
119 $obj->DESTROY()
120 Inherited, see "Cleanup" in Mail::Reporter
121
122 Attributes
123 Extends "Attributes" in User::Identity::Collection.
124
125 $obj->description()
126 Inherited, see "Attributes" in User::Identity::Item
127
128 $obj->folderType( [$folderclass] )
129 Returns the type of folder (on this location). When specified,
130 then $folderclass must be a Mail::Box extension.
131
132 $obj->itemType()
133 Inherited, see "Attributes" in User::Identity::Collection
134
135 $obj->manager()
136 The Mail::Box::Manager (usually a Mail::Box::Manage::User object),
137 which is handling the opening of folders.
138
139 $obj->name( [$newname] )
140 Inherited, see "Attributes" in User::Identity::Item
141
142 $obj->roles()
143 Inherited, see "Attributes" in User::Identity::Collection
144
145 Collections
146 Extends "Collections" in User::Identity::Collection.
147
148 $obj->add($collection, $role)
149 Inherited, see "Collections" in User::Identity::Item
150
151 $obj->addCollection( $object | <[$type], %options> )
152 Inherited, see "Collections" in User::Identity::Item
153
154 $obj->collection($name)
155 Inherited, see "Collections" in User::Identity::Item
156
157 $obj->parent( [$parent] )
158 Inherited, see "Collections" in User::Identity::Item
159
160 $obj->removeCollection($object|$name)
161 Inherited, see "Collections" in User::Identity::Item
162
163 $obj->type()
164 Mail::Box::Collection->type()
165 Inherited, see "Collections" in User::Identity::Item
166
167 $obj->user()
168 Inherited, see "Collections" in User::Identity::Item
169
170 Maintaining roles
171 Extends "Maintaining roles" in User::Identity::Collection.
172
173 $obj->addRole($role| <[$name],%options> | ARRAY)
174 Inherited, see "Maintaining roles" in User::Identity::Collection
175
176 $obj->removeRole($role|$name)
177 Inherited, see "Maintaining roles" in User::Identity::Collection
178
179 $obj->renameRole( <$role|$oldname>, $newname )
180 Inherited, see "Maintaining roles" in User::Identity::Collection
181
182 $obj->sorted()
183 Inherited, see "Maintaining roles" in User::Identity::Collection
184
185 Searching
186 Extends "Searching" in User::Identity::Collection.
187
188 $obj->find($name|CODE|undef)
189 Inherited, see "Searching" in User::Identity::Collection
190
192 Error: $object is not a collection.
193 The first argument is an object, but not of a class which extends
194 User::Identity::Collection.
195
196 Error: Cannot create a $type to add this to my collection.
197 Some options are specified to create a $type object, which is
198 native to this collection. However, for some reason this failed.
199
200 Error: Cannot load collection module for $type ($class).
201 Either the specified $type does not exist, or that module named
202 $class returns compilation errors. If the type as specified in the
203 warning is not the name of a package, you specified a nickname
204 which was not defined. Maybe you forgot the 'require' the package
205 which defines the nickname.
206
207 Error: Cannot rename $name into $newname: already exists
208 Error: Cannot rename $name into $newname: doesn't exist
209 Error: Creation of a collection via $class failed.
210 The $class did compile, but it was not possible to create an object
211 of that class using the options you specified.
212
213 Error: Don't know what type of collection you want to add.
214 If you add a collection, it must either by a collection object or a
215 list of options which can be used to create a collection object.
216 In the latter case, the type of collection must be specified.
217
218 Warning: No collection $name
219 The collection with $name does not exist and can not be created.
220
221 Error: Package $package does not implement $method.
222 Fatal error: the specific package (or one of its superclasses) does
223 not implement this method where it should. This message means that
224 some other related classes do implement this method however the
225 class at hand does not. Probably you should investigate this and
226 probably inform the author of the package.
227
228 Error: Wrong type of role for $collection: requires a $expect but got a
229 $type
230 Each $collection groups sets of roles of one specific type
231 ($expect). You cannot add objects of a different $type.
232
234 This module is part of Mail-Box distribution version 3.007, built on
235 May 03, 2019. Website: http://perl.overmeer.net/CPAN/
236
238 Copyrights 2001-2019 by [Mark Overmeer]. For other contributors see
239 ChangeLog.
240
241 This program is free software; you can redistribute it and/or modify it
242 under the same terms as Perl itself. See http://dev.perl.org/licenses/
243
244
245
246perl v5.30.0 2019-07-26 Mail::Box::Collection(3)