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 a User::Identity::Collection
11          is a User::Identity::Item
12
13        Mail::Box::Collection
14          is a Mail::Reporter
15

DESCRIPTION

17       The Mail::Box::Collection object maintains a set Mail::Box::Identity
18       objects, each describing a the location of a single mailbox (folder).
19       The collection is used by the Mail::Box::Manage::User object to
20       administer the folders of a single user, even if those folders are
21       closed.
22

OVERLOADED

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

METHODS

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

DIAGNOSTICS

171       Error: $object is not a collection.
172           The first argument is an object, but not of a class which extends
173           User::Identity::Collection.
174
175       Error: Cannot create a $type to add this to my collection.
176           Some options are specified to create a $type object, which is
177           native to this collection.  However, for some reason this failed.
178
179       Error: Cannot load collection module for $type ($class).
180           Either the specified $type does not exist, or that module named
181           $class returns compilation errors.  If the type as specified in the
182           warning is not the name of a package, you specified a nickname
183           which was not defined.  Maybe you forgot the 'require' the package
184           which defines the nickname.
185
186       Error: Cannot rename $name into $newname: already exists
187       Error: Cannot rename $name into $newname: doesn't exist
188       Error: Creation of a collection via $class failed.
189           The $class did compile, but it was not possible to create an object
190           of that class using the options you specified.
191
192       Error: Don't know what type of collection you want to add.
193           If you add a collection, it must either by a collection object or a
194           list of options which can be used to create a collection object.
195           In the latter case, the type of collection must be specified.
196
197       Warning: No collection $name
198           The collection with $name does not exist and can not be created.
199
200       Error: Package $package does not implement $method.
201           Fatal error: the specific package (or one of its superclasses) does
202           not implement this method where it should. This message means that
203           some other related classes do implement this method however the
204           class at hand does not.  Probably you should investigate this and
205           probably inform the author of the package.
206
207       Error: Wrong type of role for $collection: requires a $expect but got a
208       $type
209           Each $collection groups sets of roles of one specific type
210           ($expect).  You cannot add objects of a different $type.
211

LICENSE

217       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
218       ChangeLog.
219
220       This program is free software; you can redistribute it and/or modify it
221       under the same terms as Perl itself.  See
222       http://www.perl.com/perl/misc/Artistic.html
223
224
225
226perl v5.12.3                      2011-01-26          Mail::Box::Collection(3)