Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
Dir	[ DIR ]	drwxr-xr-x
File	[ DIR ]	drwxr-xr-x
Locker	[ DIR ]	drwxr-xr-x
MH	[ DIR ]	drwxr-xr-x
Maildir	[ DIR ]	drwxr-xr-x
Manage	[ DIR ]	drwxr-xr-x
Mbox	[ DIR ]	drwxr-xr-x
Message	[ DIR ]	drwxr-xr-x
Net	[ DIR ]	drwxr-xr-x
Parser	[ DIR ]	drwxr-xr-x
Search	[ DIR ]	drwxr-xr-x
Thread	[ DIR ]	drwxr-xr-x
Tie	[ DIR ]	drwxr-xr-x
Collection.pm	1.81 KB	-rw-r--r--
Collection.pod	8.81 KB	-rw-r--r--
Dir.pm	3.03 KB	-rw-r--r--
Dir.pod	14.62 KB	-rw-r--r--
FastScalar.pm	4.13 KB	-rw-r--r--
FastScalar.pod	969 B	-rw-r--r--
File.pm	13.08 KB	-rw-r--r--
File.pod	21.55 KB	-rw-r--r--
Identity.pm	5.66 KB	-rw-r--r--
Identity.pod	12.12 KB	-rw-r--r--
Locker.pm	3.3 KB	-rw-r--r--
Locker.pod	8.57 KB	-rw-r--r--
MH.pm	11.23 KB	-rw-r--r--
MH.pod	19.9 KB	-rw-r--r--
Maildir.pm	10.3 KB	-rw-r--r--
Maildir.pod	17.54 KB	-rw-r--r--
Manager.pm	15.14 KB	-rw-r--r--
Manager.pod	21.18 KB	-rw-r--r--
Mbox.pm	5.72 KB	-rw-r--r--
Mbox.pod	19.23 KB	-rw-r--r--
Message.pm	2.6 KB	-rw-r--r--
Message.pod	17.92 KB	-rw-r--r--
Net.pm	2.55 KB	-rw-r--r--
Net.pod	13.55 KB	-rw-r--r--
Parser.pm	3.77 KB	-rw-r--r--
Parser.pod	10.76 KB	-rw-r--r--
Search.pm	5.06 KB	-rw-r--r--
Search.pod	9.12 KB	-rw-r--r--
Test.pm	8.36 KB	-rw-r--r--
Tie.pm	923 B	-rw-r--r--
Tie.pod	1.4 KB	-rw-r--r--

Code Editor : Collection.pod

=encoding utf8

=head1 NAME

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

=head1 INHERITANCE

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

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

=head1 SYNOPSIS

=head1 DESCRIPTION

The L<Mail::Box::Collection|Mail::Box::Collection> object maintains a set L<Mail::Box::Identity|Mail::Box::Identity>
objects, each describing a the location of a single mailbox (folder).  The
collection is used by the L<Mail::Box::Manage::User|Mail::Box::Manage::User> object to administer
the folders of a single user, even if those folders are closed.

Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
 
Extends L<"DESCRIPTION" in User::Identity::Collection|User::Identity::Collection/"DESCRIPTION">.
 
=head1 OVERLOADED

Extends L<"OVERLOADED" in User::Identity::Collection|User::Identity::Collection/"OVERLOADED">.
 
=over 4

=item overload: B<@{}>

Inherited, see L<User::Identity::Collection/"OVERLOADED">

=item overload: B<stringification >

Inherited, see L<User::Identity::Collection/"OVERLOADED">

=back

=head1 METHODS

Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
 
Extends L<"METHODS" in User::Identity::Collection|User::Identity::Collection/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
 
Extends L<"Constructors" in User::Identity::Collection|User::Identity::Collection/"Constructors">.
 
=over 4

=item Mail::Box::Collection-E<gt>B<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'

=over 2

=item description => STRING

=item folder_type => CLASS

=item item_type => CLASS

=item log => LEVEL

=item manager => OBJECT

An L<Mail::Box::Manager|Mail::Box::Manager> OBJECT (could be a L<Mail::Box::Manage::User|Mail::Box::Manage::User>).

=item name => STRING

=item parent => OBJECT

=item roles => ROLE|ARRAY

=item trace => LEVEL

=back

=head2 Error handling

Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
 
=over 4

=item $obj-E<gt>B<AUTOLOAD>()