Mail::Box::Collection(3pm)				User Contributed Perl Documentation				Mail::Box::Collection(3pm)

NAME

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

INHERITANCE

	Mail::Box::Collection
	  is a User::Identity::Collection
	  is a User::Identity::Item

	Mail::Box::Collection
	  is a Mail::Reporter

DESCRIPTION

       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.

OVERLOADED

       overload: @{}()
	   See "OVERLOADED" in User::Identity::Collection

       overload: stringification()
	   See "OVERLOADED" in User::Identity::Collection

METHODS

   Constructors
       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'

	   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

   Error handling
       $obj->AUTOLOAD()
	   See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)
	   See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
       Mail::Box::Collection->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
	   See "Error handling" in Mail::Reporter

       $obj->errors()
	   See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])
       Mail::Box::Collection->log([LEVEL [,STRINGS]])
	   See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Box::Collection->logPriority(LEVEL)
	   See "Error handling" in Mail::Reporter

       $obj->logSettings()
	   See "Error handling" in Mail::Reporter

       $obj->notImplemented()
	   See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->warnings()
	   See "Error handling" in Mail::Reporter

   Cleanup
       $obj->DESTROY()
	   See "Cleanup" in Mail::Reporter

       $obj->inGlobalDestruction()
	   See "Cleanup" in Mail::Reporter

   Attributes
       $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])
	   See "Attributes" in User::Identity::Item

       $obj->roles()
	   See "Attributes" in User::Identity::Collection

   Collections
       $obj->add(COLLECTION, ROLE)
	   See "Collections" in User::Identity::Item

       $obj->addCollection(OBJECT | ([TYPE], OPTIONS))
	   See "Collections" in User::Identity::Item

       $obj->collection(NAME)
	   See "Collections" in User::Identity::Item

       $obj->parent([PARENT])
	   See "Collections" in User::Identity::Item

       $obj->removeCollection(OBJECT|NAME)
	   See "Collections" in User::Identity::Item

       $obj->type()
       Mail::Box::Collection->type()
	   See "Collections" in User::Identity::Item

       $obj->user()
	   See "Collections" in User::Identity::Item

   Maintaining roles
       $obj->addRole(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS)
	   See "Maintaining roles" in User::Identity::Collection

       $obj->removeRole(ROLE|NAME)
	   See "Maintaining roles" in User::Identity::Collection

       $obj->renameRole(ROLE|OLDNAME, NEWNAME)
	   See "Maintaining roles" in User::Identity::Collection

       $obj->sorted()
	   See "Maintaining roles" in User::Identity::Collection

   Searching
       $obj->find(NAME|CODE|undef)
	   See "Searching" in User::Identity::Collection

DIAGNOSTICS

       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 ALSO

       This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2012 by [Mark Overmeer]. For other contributors see ChangeLog.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html

perl v5.14.2							    2012-05-07						Mail::Box::Collection(3pm)