Mail::Box::Collection(3pm)

1Mail::Box::Collection(3U)ser Contributed Perl DocumentatiMoanil::Box::Collection(3)
2
3
4

NAME

6       Mail::Box::Collection - a collection of subfolders
7

INHERITANCE

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

SYNOPSIS

DESCRIPTION

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 admin‐
21       ister the folders of a single user, even if those folders are closed.
22

OVERLOADED

24       overload: @{}
25
26           See "OVERLOADED" in User::Identity::Collection
27
28       overload: stringification
29
30           See "OVERLOADED" in User::Identity::Collection
31

METHODS

33       Constructors
34
35       Mail::Box::Collection->new([NAME], OPTIONS)
36
37        Option     --Defined in     --Default
38        description  User::Identity::Item  undef
39        folder_type                   <from parent>
40        item_type    User::Identity::Collection  Mail::Box::Identity
41        log          Mail::Reporter   'WARNINGS'
42        manager                       <from parent>
43        name         User::Identity::Item  'folders'
44        parent       User::Identity::Item  undef
45        roles        User::Identity::Collection  undef
46        trace        Mail::Reporter   'WARNINGS'
47
48           . description STRING
49
50           . folder_type CLASS
51
52           . item_type CLASS
53
54           . log LEVEL
55
56           . manager OBJECT
57
58               An Mail::Box::Manager OBJECT (could be a Mail::Box::Man‐
59               age::User).
60
61           . name STRING
62
63           . parent OBJECT
64
65           . roles ROLE⎪ARRAY
66
67           . trace LEVEL
68
69       Error handling
70
71       $obj->AUTOLOAD
72
73           See "Error handling" in Mail::Reporter
74
75       $obj->addReport(OBJECT)
76
77           See "Error handling" in Mail::Reporter
78
79       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
80
81       Mail::Box::Collection->defaultTrace([LEVEL]⎪[LOGLEVEL,
82       TRACELEVEL]⎪[LEVEL, CALLBACK])
83
84           See "Error handling" in Mail::Reporter
85
86       $obj->errors
87
88           See "Error handling" in Mail::Reporter
89
90       $obj->log([LEVEL [,STRINGS]])
91
92       Mail::Box::Collection->log([LEVEL [,STRINGS]])
93
94           See "Error handling" in Mail::Reporter
95
96       $obj->logPriority(LEVEL)
97
98       Mail::Box::Collection->logPriority(LEVEL)
99
100           See "Error handling" in Mail::Reporter
101
102       $obj->logSettings
103
104           See "Error handling" in Mail::Reporter
105
106       $obj->notImplemented
107
108           See "Error handling" in Mail::Reporter
109
110       $obj->report([LEVEL])
111
112           See "Error handling" in Mail::Reporter
113
114       $obj->reportAll([LEVEL])
115
116           See "Error handling" in Mail::Reporter
117
118       $obj->trace([LEVEL])
119
120           See "Error handling" in Mail::Reporter
121
122       $obj->warnings
123
124           See "Error handling" in Mail::Reporter
125
126       Cleanup
127
128       $obj->DESTROY
129
130           See "Cleanup" in Mail::Reporter
131
132       $obj->inGlobalDestruction
133
134           See "Cleanup" in Mail::Reporter
135
136       Attributes
137
138       $obj->description
139
140           See "Attributes" in User::Identity::Item
141
142       $obj->folderType([FOLDERCLASS])
143
144           Returns the type of folder (on this location).  When specified,
145           then FOLDERCLASS must be a Mail::Box extension.
146
147       $obj->itemType
148
149           See "Attributes" in User::Identity::Collection
150
151       $obj->manager
152
153           The Mail::Box::Manager (usually a Mail::Box::Manage::User object),
154           which is handling the opening of folders.
155
156       $obj->name([NEWNAME])
157
158           See "Attributes" in User::Identity::Item
159
160       $obj->roles
161
162           See "Attributes" in User::Identity::Collection
163
164       Collections
165
166       $obj->add(COLLECTION, ROLE)
167
168           See "Collections" in User::Identity::Item
169
170       $obj->addCollection(OBJECT ⎪ ([TYPE], OPTIONS))
171
172           See "Collections" in User::Identity::Item
173
174       $obj->collection(NAME)
175
176           See "Collections" in User::Identity::Item
177
178       $obj->parent([PARENT])
179
180           See "Collections" in User::Identity::Item
181
182       $obj->removeCollection(OBJECT⎪NAME)
183
184           See "Collections" in User::Identity::Item
185
186       $obj->type
187
188       Mail::Box::Collection->type
189
190           See "Collections" in User::Identity::Item
191
192       $obj->user
193
194           See "Collections" in User::Identity::Item
195
196       Maintaining roles
197
198       $obj->addRole(ROLE⎪ ( [NAME],OPTIONS ) ⎪ ARRAY-OF-OPTIONS)
199
200           See "Maintaining roles" in User::Identity::Collection
201
202       $obj->removeRole(ROLE⎪NAME)
203
204           See "Maintaining roles" in User::Identity::Collection
205
206       $obj->renameRole(ROLE⎪OLDNAME, NEWNAME)
207
208           See "Maintaining roles" in User::Identity::Collection
209
210       $obj->sorted
211
212           See "Maintaining roles" in User::Identity::Collection
213
214       Searching
215
216       $obj->find(NAME⎪CODE⎪undef)
217
218           See "Searching" in User::Identity::Collection
219

DIAGNOSTICS

221       Error: $object is not a collection.
222
223       The first argument is an object, but not of a class which extends
224       User::Identity::Collection.
225
226       Error: Cannot create a $type to add this to my collection.
227
228       Some options are specified to create a $type object, which is native to
229       this collection.  However, for some reason this failed.
230
231       Error: Cannot load collection module for $type ($class).
232
233       Either the specified $type does not exist, or that module named $class
234       returns compilation errors.  If the type as specified in the warning is
235       not the name of a package, you specified a nickname which was not
236       defined.  Maybe you forgot the 'require' the package which defines the
237       nickname.
238
239       Error: Cannot rename $name into $newname: already exists
240
241       Error: Cannot rename $name into $newname: doesn't exist
242
243       Error: Creation of a collection via $class failed.
244
245       The $class did compile, but it was not possible to create an object of
246       that class using the options you specified.
247
248       Error: Don't know what type of collection you want to add.
249
250       If you add a collection, it must either by a collection object or a
251       list of options which can be used to create a collection object.  In
252       the latter case, the type of collection must be specified.
253
254       Warning: No collection $name
255
256       The collection with $name does not exist and can not be created.
257
258       Error: Package $package does not implement $method.
259
260       Fatal error: the specific package (or one of its superclasses) does not
261       implement this method where it should. This message means that some
262       other related classes do implement this method however the class at
263       hand does not.  Probably you should investigate this and probably
264       inform the author of the package.
265
266       Error: Wrong type of role for $collection: requires a $expect but got a
267       $type
268
269       Each $collection groups sets of roles of one specific type ($expect).
270       You cannot add objects of a different $type.
271

LICENSE

277       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
278       ChangeLog.
279
280       This program is free software; you can redistribute it and/or modify it
281       under the same terms as Perl itself.  See
282       http://www.perl.com/perl/misc/Artistic.html
283
284
285
286perl v5.8.8                       2007-03-25          Mail::Box::Collection(3)