--- name: "Mail::Box::Collection" section: "3pm" platform: "linux" package: "perl-mail-box" version: "4.02-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/Mail::Box::Collection" --- # Mail::Box::Collection(3pm) a collection of subfolders ## 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 ``` ## SYNOPSIS ## 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. Extends "DESCRIPTION" in Mail::Reporter. Extends "DESCRIPTION" in User::Identity::Collection. ## OVERLOADED Extends "OVERLOADED" in User::Identity::Collection. - overload: **'""'** stringification Inherited, see "OVERLOADED" in User::Identity::Collection - overload: **'@{}'** array dereference Inherited, see "OVERLOADED" in User::Identity::Collection ## METHODS Extends "METHODS" in Mail::Reporter. Extends "METHODS" in User::Identity::Collection. ### Constructors Extends "Constructors" in Mail::Reporter. Extends "Constructors" in User::Identity::Collection. - $class-\>**new**( \[$name\], %options ) Inherited, see "Constructors" in Mail::Reporter ``` -Option --Defined in --Default description User::Identity::Item undef folder_type item_type User::Identity::Collection Mail::Box::Identity manager name User::Identity::Item 'folders' parent User::Identity::Item undef roles User::Identity::Collection undef ``` - description =\> STRING - folder\_type =\> $class - item\_type =\> CLASS - manager =\> $object A pre-prepared Mail::Box::Manager `$object` (could be a Mail::Box::Manage::User). - name =\> STRING - parent =\> OBJECT - roles =\> $role\|\\@roles ### Attributes Extends "Attributes" in Mail::Reporter. Extends "Attributes" in User::Identity::Collection. - $obj-\>**description**() Inherited, 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**() Inherited, 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\] ) Inherited, see "Attributes" in User::Identity::Item - $obj-\>**roles**() Inherited, see "Attributes" in User::Identity::Collection ### Collections Extends "Collections" in User::Identity::Collection. - $obj-\>**add**($collection, $role) Inherited, see "Collections" in User::Identity::Item - $obj-\>**addCollection**( $object \| \<\[$type\], %options\> ) Inherited, see "Collections" in User::Identity::Item - $obj-\>**collection**($name) Inherited, see "Collections" in User::Identity::Item - $obj-\>**parent**( \[$parent\] ) Inherited, see "Collections" in User::Identity::Item - $obj-\>**removeCollection**($object\|$name) Inherited, see "Collections" in User::Identity::Item - $any-\>**type**() Inherited, see "Collections" in User::Identity::Item - $obj-\>**user**() Inherited, see "Collections" in User::Identity::Item ### Maintaining roles Extends "Maintaining roles" in User::Identity::Collection. - $obj-\>**addRole**($role\|(\[$name\], %options)) Inherited, see "Maintaining roles" in User::Identity::Collection - $obj-\>**removeRole**($role\|$name) Inherited, see "Maintaining roles" in User::Identity::Collection - $obj-\>**renameRole**( \<$role\|$oldname\>, $newname ) Inherited, see "Maintaining roles" in User::Identity::Collection - $obj-\>**sorted**() Inherited, see "Maintaining roles" in User::Identity::Collection ### Searching Extends "Searching" in User::Identity::Collection. - $obj-\>**find**($name\|CODE\|undef) Inherited, see "Searching" in User::Identity::Collection ### Error handling Extends "Error handling" in Mail::Reporter. - $obj-\>**AUTOLOAD**() Inherited, see "Error handling" in Mail::Reporter - $obj-\>**notImplemented**() Inherited, see "Error handling" in Mail::Reporter ### Cleanup Extends "Cleanup" in Mail::Reporter. - $obj-\>**DESTROY**() Inherited, see "Cleanup" in Mail::Reporter ## DIAGNOSTICS - 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. Cast by `addRole()` - 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. Cast by `addCollection()` - Error: cannot rename $from into $to: already exists. Cast by `renameRole()` - Error: cannot rename $from into $to: doesn't exist. Cast by `renameRole()` - Error: class $package does not implement method $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. Cast by `notImplemented()` - Error: invalid collection $name. The collection with `$name` does not exist and can not be created. Cast by `add()` - Error: this $object is not a collection. Cast by `addCollection()` - 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`. Cast by `addRole()` ## SEE ALSO This module is part of Mail-Box version 4.02, built on April 10, 2026. Website: *http://perl.overmeer.net/CPAN/* ## LICENSE For contributors see file ChangeLog. This software is copyright (c) 2001-2026 by Mark Overmeer. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.