.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Mail::Box::Identity 3pm"
.TH Mail::Box::Identity 3pm "2014-08-24" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::Box::Identity \- represents an unopened folder
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Mail::Box::Identity
\&   is a User::Identity::Item
\&
\& Mail::Box::Identity
\&   is a Mail::Reporter
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use User::Identity;
\& use Mail::Box::Identity;
\& my $me   = User::Identity\->new(...);
\&
\& my $mailbox = Mail::Box::Identity\->new(...);
\& $me\->add(folders => $mailbox);
\&
\& # Simpler
\&
\& use User::Identity;
\& my $me   = User::Identity\->new(...);
\& my $addr = $me\->add(folders => ...);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Mail::Box::Identity\*(C'\fR object contains the description of a
single mailbox.  The mailboxes are collected by an Mail::Box::Collection
object.  This corresponds with \s-1IMAP\s0's \f(CW\*(C`\eNoSelect\*(C'\fR, for instance.
.PP
Nearly all methods can return undef.
.PP
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Mail::Reporter.
.PP
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in User::Identity::Item.
.SH "METHODS"
.IX Header "METHODS"
Extends \*(L"\s-1METHODS\*(R"\s0 in Mail::Reporter.
.PP
Extends \*(L"\s-1METHODS\*(R"\s0 in User::Identity::Item.
.SS "Constructors"
.IX Subsection "Constructors"
Extends \*(L"Constructors\*(R" in Mail::Reporter.
.PP
Extends \*(L"Constructors\*(R" in User::Identity::Item.
.ie n .IP "Mail::Box::Identity\->\fBnew\fR( [$name], %options )" 4
.el .IP "Mail::Box::Identity\->\fBnew\fR( [$name], \f(CW%options\fR )" 4
.IX Item "Mail::Box::Identity->new( [$name], %options )"
.Vb 10
\& \-Option     \-\-Defined in          \-\-Default
\&  deleted                            <false>
\&  description  User::Identity::Item  undef
\&  folder_type                        from parent
\&  inferiors                          1
\&  location                           undef
\&  log          Mail::Reporter        \*(AqWARNINGS\*(Aq
\&  manager                            <from parent>
\&  marked                             undef
\&  name         User::Identity::Item  <required>
\&  only_subs                          <foldertype and name dependent>
\&  parent       User::Identity::Item  undef
\&  subf_type                          <same as parent>
\&  trace        Mail::Reporter        \*(AqWARNINGS\*(Aq
.Ve
.RS 4
.IP "deleted => \s-1BOOLEAN\s0" 2
.IX Item "deleted => BOOLEAN"
The folder is flagged for deletion.  This not have any implications yet,
because it may still get undeleted.
.IP "description => \s-1STRING\s0" 2
.IX Item "description => STRING"
.PD 0
.IP "folder_type => \s-1CLASS\s0" 2
.IX Item "folder_type => CLASS"
.IP "inferiors => \s-1BOOLEAN\s0" 2
.IX Item "inferiors => BOOLEAN"
.PD
Can this folder have children?  If not, this is cleared.
.IP "location => DIRECTORY|FILENAME" 2
.IX Item "location => DIRECTORY|FILENAME"
The location of this folder.  Often, only the manager can figure-out
where this folder really is.
.IP "log => \s-1LEVEL\s0" 2
.IX Item "log => LEVEL"
.PD 0
.IP "manager => \s-1OBJECT\s0" 2
.IX Item "manager => OBJECT"
.PD
Any Mail::Box::Manager or Mail::Box::Manage::User \s-1OBJECT.\s0
.ie n .IP "marked => BOOLEAN|""undef""" 2
.el .IP "marked => BOOLEAN|\f(CWundef\fR" 2
.IX Item "marked => BOOLEAN|undef"
Whether the folder is flagged for some reason, for instance because
new messages have arrived.
.IP "name => \s-1STRING\s0" 2
.IX Item "name => STRING"
.PD 0
.IP "only_subs => \s-1BOOLEAN\s0" 2
.IX Item "only_subs => BOOLEAN"
.PD
Some folder types can have messages in their toplevel folder, other
cannot. That determines the default.
See \fIMail::Box::topFolderWithMessages()\fR
.IP "parent => \s-1OBJECT\s0" 2
.IX Item "parent => OBJECT"
.PD 0
.IP "subf_type => \s-1CLASS\s0" 2
.IX Item "subf_type => CLASS"
.PD
The type for a subfolder collection, must extend \s-1CLASS
\&\s0Mail::Box::Collection.
.IP "trace => \s-1LEVEL\s0" 2
.IX Item "trace => LEVEL"
.RE
.RS 4
.RE
.SS "Attributes"
.IX Subsection "Attributes"
Extends \*(L"Attributes\*(R" in User::Identity::Item.
.ie n .IP "$obj\->\fBdescription\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBdescription\fR()" 4
.IX Item "$obj->description()"
Inherited, see \*(L"Attributes\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBfolderType\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBfolderType\fR()" 4
.IX Item "$obj->folderType()"
Returns the type of this folder.
.ie n .IP "$obj\->\fBfullname\fR( [$delimeter] )" 4
.el .IP "\f(CW$obj\fR\->\fBfullname\fR( [$delimeter] )" 4
.IX Item "$obj->fullname( [$delimeter] )"
Returns the name of the folder, from the toplevel until this one, with
the \f(CW$delimeter\fR string between each level.  \f(CW$delimeter\fR default to a forward
slash (a \f(CW\*(C`/\*(C'\fR).
.ie n .IP "$obj\->\fBinferiors\fR( [\s-1BOOLEAN\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBinferiors\fR( [\s-1BOOLEAN\s0] )" 4
.IX Item "$obj->inferiors( [BOOLEAN] )"
\&\f(CW\*(C`Inferiors\*(C'\fR are \f(CW\*(C`subfolders\*(C'\fR.  When this flag is set, it is permitted
to create subfolders.
.ie n .IP "$obj\->\fBlocation\fR( [$filename|$directory|undef] )" 4
.el .IP "\f(CW$obj\fR\->\fBlocation\fR( [$filename|$directory|undef] )" 4
.IX Item "$obj->location( [$filename|$directory|undef] )"
Returns the directory or filename of the folder.  If this is not pre-defined,
it is computed based on the knowledge about the folder type.  Be sure to set
the location of the toplevel folder to the folderdir of the user to get
this to work.
.ie n .IP "$obj\->\fBmanager\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBmanager\fR()" 4
.IX Item "$obj->manager()"
Returns the manager (usually a Mail::Box::Manage::User which owns
the folders.  May be undefined, by default from parent.
.ie n .IP "$obj\->\fBmarked\fR( [BOOLEAN|undef] )" 4
.el .IP "\f(CW$obj\fR\->\fBmarked\fR( [BOOLEAN|undef] )" 4
.IX Item "$obj->marked( [BOOLEAN|undef] )"
When something special has happened with the folder, this flag can
be set (or cleared).  The \f(CW\*(C`undef\*(C'\fR status is an \*(L"unknown\*(R".  In the
\&\s-1IMAP4\s0 protocol, \f(CW0\fR will result in a \f(CW\*(C`\eUnmarked\*(C'\fR, a \f(CW1\fR results
in a \f(CW\*(C`\eMarked\*(C'\fR, and \f(CW\*(C`undef\*(C'\fR in nothing.
.ie n .IP "$obj\->\fBname\fR( [\s-1NEWNAME\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBname\fR( [\s-1NEWNAME\s0] )" 4
.IX Item "$obj->name( [NEWNAME] )"
Inherited, see \*(L"Attributes\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBonlySubfolders\fR( [\s-1BOOLEAN\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBonlySubfolders\fR( [\s-1BOOLEAN\s0] )" 4
.IX Item "$obj->onlySubfolders( [BOOLEAN] )"
Than this folder be opened (without trying) or not?  The default
depends on the folder type, and whether this is the toplevel folder
or not.  See \fIMail::Box::topFolderWithMessages()\fR
.ie n .IP "$obj\->\fBtopfolder\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBtopfolder\fR()" 4
.IX Item "$obj->topfolder()"
Run up the tree to find the highest level folder.
.SS "Collections"
.IX Subsection "Collections"
Extends \*(L"Collections\*(R" in User::Identity::Item.
.ie n .IP "$obj\->\fBadd\fR(\s-1COLLECTION, ROLE\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBadd\fR(\s-1COLLECTION, ROLE\s0)" 4
.IX Item "$obj->add(COLLECTION, ROLE)"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBaddCollection\fR(\s-1OBJECT\s0 | ([\s-1TYPE\s0], \s-1OPTIONS\s0))" 4
.el .IP "\f(CW$obj\fR\->\fBaddCollection\fR(\s-1OBJECT\s0 | ([\s-1TYPE\s0], \s-1OPTIONS\s0))" 4
.IX Item "$obj->addCollection(OBJECT | ([TYPE], OPTIONS))"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBcollection\fR(\s-1NAME\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBcollection\fR(\s-1NAME\s0)" 4
.IX Item "$obj->collection(NAME)"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBfind\fR(\s-1COLLECTION, ROLE\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBfind\fR(\s-1COLLECTION, ROLE\s0)" 4
.IX Item "$obj->find(COLLECTION, ROLE)"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBparent\fR( [\s-1PARENT\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBparent\fR( [\s-1PARENT\s0] )" 4
.IX Item "$obj->parent( [PARENT] )"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBremoveCollection\fR(OBJECT|NAME)" 4
.el .IP "\f(CW$obj\fR\->\fBremoveCollection\fR(OBJECT|NAME)" 4
.IX Item "$obj->removeCollection(OBJECT|NAME)"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBtype\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBtype\fR()" 4
.IX Item "$obj->type()"
.PD 0
.IP "Mail::Box::Identity\->\fBtype\fR()" 4
.IX Item "Mail::Box::Identity->type()"
.PD
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.ie n .IP "$obj\->\fBuser\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBuser\fR()" 4
.IX Item "$obj->user()"
Inherited, see \*(L"Collections\*(R" in User::Identity::Item
.SS "Subfolders"
.IX Subsection "Subfolders"
.ie n .IP "$obj\->\fBaddSubfolder\fR($m<Mail::Box::Identity>|$data)" 4
.el .IP "\f(CW$obj\fR\->\fBaddSubfolder\fR($m<Mail::Box::Identity>|$data)" 4
.IX Item "$obj->addSubfolder($m<Mail::Box::Identity>|$data)"
Add a new folder into the administration.  With \f(CW$data\fR, a new object
will be instantiated first.  The identity is returned on success.
.ie n .IP "$obj\->\fBfolder\fR( [..., $name] )" 4
.el .IP "\f(CW$obj\fR\->\fBfolder\fR( [..., \f(CW$name\fR] )" 4
.IX Item "$obj->folder( [..., $name] )"
Returns the subfolder's object with \f(CW$name\fR or \f(CW\*(C`undef\*(C'\fR if it does not
exist.  When multiple NAMEs are added, those super folders are traverst
first.  Without any \f(CW$name\fR, the current object is returned
.Sp
example: get some folder
.Sp
.Vb 1
\& my $a = $user\->folders\->folder(\*(Aqb\*(Aq, \*(Aqa\*(Aq);
\&
\& my $name  = "a:b:c";
\& my $delim = ":";
\& my $f = $user\->folders\->folder(split $delim, $name);
.Ve
.ie n .IP "$obj\->\fBforeach\fR(\s-1CODE\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBforeach\fR(\s-1CODE\s0)" 4
.IX Item "$obj->foreach(CODE)"
For each of the subfolders found below this point call \s-1CODE. \s0 This current
folder is called first.  Be warned that you may find identities with
the Mail::Box::Identity subroutine deleted flag on.
.ie n .IP "$obj\->\fBopen\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBopen\fR(%options)" 4
.IX Item "$obj->open(%options)"
Open the folder which is described by this identity.  Returned is some
Mail::Box.  The options are passed to \fIMail::Box::Manager::open()\fR.
.ie n .IP "$obj\->\fBremove\fR( [$name] )" 4
.el .IP "\f(CW$obj\fR\->\fBremove\fR( [$name] )" 4
.IX Item "$obj->remove( [$name] )"
Remove the folder (plus subfolders) with the \f(CW$name\fR.  Without \f(CW$name\fR, this
\&\f(CW\*(C`Mail::Box::Identity\*(C'\fR itself is removed.
.Sp
The removed structure is returned, which is \f(CW\*(C`undef\*(C'\fR if not
found.  This is only an administrative remove, you still need a
\&\fIMail::Box::Manager::delete()\fR.
.ie n .IP "$obj\->\fBrename\fR( $folder, [$newsubname] )" 4
.el .IP "\f(CW$obj\fR\->\fBrename\fR( \f(CW$folder\fR, [$newsubname] )" 4
.IX Item "$obj->rename( $folder, [$newsubname] )"
Move the folder to a different super\-$folder, under a \s-1NEW\s0 SUBfolder \s-1NAME.\s0
.Sp
example: renaming a folder
.Sp
.Vb 3
\& my $top = $user\->topfolder;
\& my $new = $top\->folder(\*(Aqxyz\*(Aq) or die;
\& my $f   = $top\->folder(\*(Aqabc\*(Aq, \*(Aqdef\*(Aq)\->rename($new, \*(Aq123\*(Aq);
\&
\& print $f\->name;      # 123
\& print $f\->fullname;  # =/xyz/123
.Ve
.ie n .IP "$obj\->\fBsubfolderNames\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBsubfolderNames\fR()" 4
.IX Item "$obj->subfolderNames()"
Convenience method: returns the names of the collected subfolders.
.ie n .IP "$obj\->\fBsubfolders\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBsubfolders\fR()" 4
.IX Item "$obj->subfolders()"
Returns the subfolders or \f(CW\*(C`undef\*(C'\fR if there are none.  This
information is lazy evaluated and cached.  In \s-1LIST\s0 context, the folder
objects are returned (Mail::Box::Identity objects), in \s-1SCALAR\s0 context
the collection, the Mail::Box::Collection.
.SS "Error handling"
.IX Subsection "Error handling"
Extends \*(L"Error handling\*(R" in Mail::Reporter.
.ie n .IP "$obj\->\fB\s-1AUTOLOAD\s0\fR()" 4
.el .IP "\f(CW$obj\fR\->\fB\s-1AUTOLOAD\s0\fR()" 4
.IX Item "$obj->AUTOLOAD()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBaddReport\fR($object)" 4
.el .IP "\f(CW$obj\fR\->\fBaddReport\fR($object)" 4
.IX Item "$obj->addReport($object)"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "\f(CW$obj\fR\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD 0
.ie n .IP "Mail::Box::Identity\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "Mail::Box::Identity\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "Mail::Box::Identity->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBerrors\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBerrors\fR()" 4
.IX Item "$obj->errors()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBlog\fR( [$level, [$strings]] )" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "$obj->log( [$level, [$strings]] )"
.PD 0
.IP "Mail::Box::Identity\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "Mail::Box::Identity->log( [$level, [$strings]] )"
.PD
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBlogPriority\fR($level)" 4
.el .IP "\f(CW$obj\fR\->\fBlogPriority\fR($level)" 4
.IX Item "$obj->logPriority($level)"
.PD 0
.IP "Mail::Box::Identity\->\fBlogPriority\fR($level)" 4
.IX Item "Mail::Box::Identity->logPriority($level)"
.PD
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBlogSettings\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBlogSettings\fR()" 4
.IX Item "$obj->logSettings()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBnotImplemented\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBnotImplemented\fR()" 4
.IX Item "$obj->notImplemented()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBreport\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBreport\fR( [$level] )" 4
.IX Item "$obj->report( [$level] )"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBreportAll\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBreportAll\fR( [$level] )" 4
.IX Item "$obj->reportAll( [$level] )"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBtrace\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBtrace\fR( [$level] )" 4
.IX Item "$obj->trace( [$level] )"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBwarnings\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBwarnings\fR()" 4
.IX Item "$obj->warnings()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.SS "Cleanup"
.IX Subsection "Cleanup"
Extends \*(L"Cleanup\*(R" in Mail::Reporter.
.ie n .IP "$obj\->\fB\s-1DESTROY\s0\fR()" 4
.el .IP "\f(CW$obj\fR\->\fB\s-1DESTROY\s0\fR()" 4
.IX Item "$obj->DESTROY()"
Inherited, see \*(L"Cleanup\*(R" in Mail::Reporter
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP "Error: $object is not a collection." 4
.el .IP "Error: \f(CW$object\fR is not a collection." 4
.IX Item "Error: $object is not a collection."
The first argument is an object, but not of a class which extends
User::Identity::Collection.
.ie n .IP "Error: Cannot load collection module for $type ($class)." 4
.el .IP "Error: Cannot load collection module for \f(CW$type\fR ($class)." 4
.IX Item "Error: Cannot load collection module for $type ($class)."
Either the specified \f(CW$type\fR does not exist, or that module named \f(CW$class\fR 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.
.ie n .IP "Error: Creation of a collection via $class failed." 4
.el .IP "Error: Creation of a collection via \f(CW$class\fR failed." 4
.IX Item "Error: Creation of a collection via $class failed."
The \f(CW$class\fR did compile, but it was not possible to create an object
of that class using the options you specified.
.IP "Error: Don't know what type of collection you want to add." 4
.IX Item "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.
.ie n .IP "Error: It is not permitted to add subfolders to $name" 4
.el .IP "Error: It is not permitted to add subfolders to \f(CW$name\fR" 4
.IX Item "Error: It is not permitted to add subfolders to $name"
The \f(CW$m\fR<\fIinferiors()\fR> flag prohibits the creation of subfolders to this
folder.
.ie n .IP "Warning: No collection $name" 4
.el .IP "Warning: No collection \f(CW$name\fR" 4
.IX Item "Warning: No collection $name"
The collection with \f(CW$name\fR does not exist and can not be created.
.ie n .IP "Error: Package $package does not implement $method." 4
.el .IP "Error: Package \f(CW$package\fR does not implement \f(CW$method\fR." 4
.IX Item "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.
.IP "Error: The toplevel folder cannot be removed this way" 4
.IX Item "Error: The toplevel folder cannot be removed this way"
The Mail::Box::Identity folder administration structure requires
a top directory.  That top is registered somewhere (for instance
by a Mail::Box::Manage::User).  If you need to remove the top,
you have to look for a method of that object.
.IP "Error: Toplevel directory requires explicit folder type" 4
.IX Item "Error: Toplevel directory requires explicit folder type"
.PD 0
.IP "Error: Toplevel directory requires explicit location" 4
.IX Item "Error: Toplevel directory requires explicit location"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail-Box distribution version 2.117,
built on August 24, 2014. Website: \fIhttp://perl.overmeer.net/mailbox/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2001\-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR