GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::BOX::COLLECTION (3)

.ds Aq ’

NAME

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

CONTENTS

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.

See documentation in the base class.

See documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>@{}B>() See OVERLOADED in User::Identity::Collection
overload: <B>stringificationB>() See OVERLOADED in User::Identity::Collection

METHODS

See documentation in the base class.

See documentation in the base class.

    Constructors

See documentation in the base class.

See documentation in the base class.
Mail::Box::Collection-><B>newB>([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

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Collection-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::Collection-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::Collection-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

    Attributes

See documentation in the base class.
$obj-><B>descriptionB>() See Attributes in User::Identity::Item
$obj-><B>folderTypeB>([FOLDERCLASS]) Returns the type of folder (on this location). When specified, then FOLDERCLASS must be a Mail::Box extension.
$obj-><B>itemTypeB>() See Attributes in User::Identity::Collection
$obj-><B>managerB>() The Mail::Box::Manager (usually a Mail::Box::Manage::User object), which is handling the opening of folders.
$obj-><B>nameB>([NEWNAME]) See Attributes in User::Identity::Item
$obj-><B>rolesB>() See Attributes in User::Identity::Collection

    Collections

See documentation in the base class.
$obj-><B>addB>(COLLECTION, ROLE) See Collections in User::Identity::Item
$obj-><B>addCollectionB>(OBJECT | ([TYPE], OPTIONS)) See Collections in User::Identity::Item
$obj-><B>collectionB>(NAME) See Collections in User::Identity::Item
$obj-><B>parentB>([PARENT]) See Collections in User::Identity::Item
$obj-><B>removeCollectionB>(OBJECT|NAME) See Collections in User::Identity::Item
$obj-><B>typeB>()
Mail::Box::Collection-><B>typeB>() See Collections in User::Identity::Item
$obj-><B>userB>() See Collections in User::Identity::Item

    Maintaining roles

See documentation in the base class.
$obj-><B>addRoleB>(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS) See Maintaining roles in User::Identity::Collection
$obj-><B>removeRoleB>(ROLE|NAME) See Maintaining roles in User::Identity::Collection
$obj-><B>renameRoleB>(ROLE|OLDNAME, NEWNAME) See Maintaining roles in User::Identity::Collection
$obj-><B>sortedB>() See Maintaining roles in User::Identity::Collection

    Searching

See documentation in the base class.
$obj-><B>findB>(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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::BOX::COLLECTION (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.