Mail::Box::Collection - a collection of subfolders
Mail::Box::Collection is an User::Identity::Collection is an User::Identity::Item Mail::Box::Collection is a Mail::Reporter
The Mail::Box::Collection object maintains a set Mail::Box::Identity objects, each describing a the location of a single mailbox (folder). The collection is used by the Mail::Box::Manage::User object to administer the folders of a single user, even if those folders are closed.
overload: @{}
See "OVERLOADED" in User::Identity::Collection
overload: stringification
Mail::Box::Collection->new([NAME], OPTIONS)
-Option --Defined in --Default description User::Identity::Item undef folder_type <from parent> item_type User::Identity::Collection Mail::Box::Identity log Mail::Reporter 'WARNINGS' manager <from parent> name User::Identity::Item 'folders' parent User::Identity::Item undef roles User::Identity::Collection undef trace Mail::Reporter 'WARNINGS'
'WARNINGS'
'folders'
undef
. description STRING
. folder_type CLASS
. item_type CLASS
. log LEVEL
. manager OBJECT
An Mail::Box::Manager OBJECT (could be a Mail::Box::Manage::User).
. name STRING
. parent OBJECT
. roles ROLE|ARRAY
. trace LEVEL
$obj->AUTOLOAD
See "Error handling" in Mail::Reporter
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Collection->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Collection->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Box::Collection->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
$obj->DESTROY
See "Cleanup" in Mail::Reporter
$obj->inGlobalDestruction
$obj->description
See "Attributes" in User::Identity::Item
$obj->folderType([FOLDERCLASS])
Returns the type of folder (on this location). When specified, then FOLDERCLASS must be a Mail::Box extension.
$obj->itemType
See "Attributes" in User::Identity::Collection
$obj->manager
The Mail::Box::Manager (usually a Mail::Box::Manage::User object), which is handling the opening of folders.
$obj->name([NEWNAME])
$obj->roles
$obj->add(COLLECTION, ROLE)
See "Collections" in User::Identity::Item
$obj->addCollection(OBJECT | ([TYPE], OPTIONS))
$obj->collection(NAME)
$obj->parent([PARENT])
$obj->removeCollection(OBJECT|NAME)
$obj->type
Mail::Box::Collection->type
$obj->user
$obj->addRole(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS)
See "Maintaining roles" in User::Identity::Collection
$obj->removeRole(ROLE|NAME)
$obj->renameRole(ROLE|OLDNAME, NEWNAME)
$obj->sorted
$obj->find(NAME|CODE|undef)
See "Searching" in User::Identity::Collection
Error: $object is not a collection.
The first argument is an object, but not of a class which extends User::Identity::Collection.
Error: Cannot create a $type to add this to my collection.
Some options are specified to create a $type object, which is native to this collection. However, for some reason this failed.
Error: Cannot load collection module for $type ($class).
Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname.
Error: Cannot rename $name into $newname: already exists
Error: Cannot rename $name into $newname: doesn't exist
Error: Creation of a collection via $class failed.
The $class did compile, but it was not possible to create an object of that class using the options you specified.
Error: Don't know what type of collection you want to add.
If you add a collection, it must either by a collection object or a list of options which can be used to create a collection object. In the latter case, the type of collection must be specified.
Warning: No collection $name
The collection with $name does not exist and can not be created.
Error: Package $package does not implement $method.
Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.
Error: Wrong type of role for $collection: requires a $expect but got a $type
Each $collection groups sets of roles of one specific type ($expect). You cannot add objects of a different $type.
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
Distribution version 2.066. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.