.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Mail::Box::Net 3"
.TH Mail::Box::Net 3 2026-04-11 "perl v5.42.2" "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::Net \- handle folders which are stored remote.
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\& Mail::Box::Net
\&   is a Mail::Box
\&   is a Mail::Reporter
\&
\& Mail::Box::Net is extended by
\&   Mail::Box::IMAP4
\&   Mail::Box::POP3
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  # Do not instantiate this object directly
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
At the moment, this object is extended by
.IP \(bu 4
Mail::Box::POP3
.Sp
Implements the POP3 protocol.
.IP \(bu 4
Mail::Box::IMAP4
.Sp
Implements the IMAP4 protocol.
.PP
Extends "DESCRIPTION" in Mail::Box.
.SH OVERLOADED
.IX Header "OVERLOADED"
Extends "OVERLOADED" in Mail::Box.
.IP "overload: \fB\*(Aq""""\*(Aq\fR stringification" 4
.IX Item "overload: '""""' stringification"
Inherited, see "OVERLOADED" in Mail::Box
.IP "overload: \fB\*(Aq@{}\*(Aq\fR use as ARRAY" 4
.IX Item "overload: '@{}' use as ARRAY"
Inherited, see "OVERLOADED" in Mail::Box
.IP "overload: \fBcmp\fR string comparison" 4
.IX Item "overload: cmp string comparison"
Inherited, see "OVERLOADED" in Mail::Box
.SH METHODS
.IX Header "METHODS"
Extends "METHODS" in Mail::Box.
.SS Constructors
.IX Subsection "Constructors"
Extends "Constructors" in Mail::Box.
.ie n .IP $class\->\fBnew\fR(%options) 4
.el .IP \f(CW$class\fR\->\fBnew\fR(%options) 4
.IX Item "$class->new(%options)"
Inherited, see "Constructors" in Mail::Box
.Sp
.Vb 10
\& \-Option           \-\-Defined in     \-\-Default
\&  access             Mail::Box        \*(Aqr\*(Aq
\&  body_delayed_type  Mail::Box        Mail::Message::Body::Delayed
\&  body_type          Mail::Box        Mail::Message::Body::Lines
\&  coerce_options     Mail::Box        +[]
\&  create             Mail::Box        false
\&  extract            Mail::Box        10240
\&  field_type         Mail::Box        undef
\&  fix_headers        Mail::Box        false
\&  folder             Mail::Box        \*(Aq/\*(Aq
\&  folderdir          Mail::Box        <network location>
\&  head_delayed_type  Mail::Box        Mail::Message::Head::Delayed
\&  head_type          Mail::Box        Mail::Message::Head::Complete
\&  keep_dups          Mail::Box        false
\&  lock_file          Mail::Box        undef
\&  lock_timeout       Mail::Box        1 hour
\&  lock_type          Mail::Box        \*(AqNONE\*(Aq
\&  lock_wait          Mail::Box        10 seconds
\&  locker             Mail::Box        undef
\&  manager            Mail::Box        undef
\&  message_type       Mail::Box        <folder\-class>::Message
\&  multipart_type     Mail::Box        Mail::Message::Body::Multipart
\&  password                            undef
\&  remove_when_empty  Mail::Box        <false>
\&  save_on_exit       Mail::Box        true
\&  server_name                         undef
\&  server_port                         undef
\&  trusted            Mail::Box        <false>
\&  username                            undef
.Ve
.RS 4
.ie n .IP "access => $mode" 2
.el .IP "access => \f(CW$mode\fR" 2
.IX Item "access => $mode"
.PD 0
.IP "body_delayed_type => CLASS" 2
.IX Item "body_delayed_type => CLASS"
.IP "body_type => CLASS|CODE" 2
.IX Item "body_type => CLASS|CODE"
.IP "coerce_options => ARRAY" 2
.IX Item "coerce_options => ARRAY"
.IP "create => BOOLEAN" 2
.IX Item "create => BOOLEAN"
.IP "extract => INTEGER|CODE|METHOD|\*(AqLAZY\*(Aq|\*(AqALWAYS\*(Aq" 2
.IX Item "extract => INTEGER|CODE|METHOD|'LAZY'|'ALWAYS'"
.ie n .IP "field_type => $class" 2
.el .IP "field_type => \f(CW$class\fR" 2
.IX Item "field_type => $class"
.IP "fix_headers => BOOLEAN" 2
.IX Item "fix_headers => BOOLEAN"
.ie n .IP "folder => $name" 2
.el .IP "folder => \f(CW$name\fR" 2
.IX Item "folder => $name"
.ie n .IP "folderdir => $directory" 2
.el .IP "folderdir => \f(CW$directory\fR" 2
.IX Item "folderdir => $directory"
.ie n .IP "head_delayed_type => $class" 2
.el .IP "head_delayed_type => \f(CW$class\fR" 2
.IX Item "head_delayed_type => $class"
.ie n .IP "head_type => $class" 2
.el .IP "head_type => \f(CW$class\fR" 2
.IX Item "head_type => $class"
.IP "keep_dups => BOOLEAN" 2
.IX Item "keep_dups => BOOLEAN"
.ie n .IP "lock_file => $file" 2
.el .IP "lock_file => \f(CW$file\fR" 2
.IX Item "lock_file => $file"
.ie n .IP "lock_timeout => $seconds" 2
.el .IP "lock_timeout => \f(CW$seconds\fR" 2
.IX Item "lock_timeout => $seconds"
.ie n .IP "lock_type => $class|$name|\e@names" 2
.el .IP "lock_type => \f(CW$class\fR|$name|\e@names" 2
.IX Item "lock_type => $class|$name|@names"
.ie n .IP "lock_wait => $seconds" 2
.el .IP "lock_wait => \f(CW$seconds\fR" 2
.IX Item "lock_wait => $seconds"
.ie n .IP "locker => $locker" 2
.el .IP "locker => \f(CW$locker\fR" 2
.IX Item "locker => $locker"
.ie n .IP "manager => $manager" 2
.el .IP "manager => \f(CW$manager\fR" 2
.IX Item "manager => $manager"
.ie n .IP "message_type => $class" 2
.el .IP "message_type => \f(CW$class\fR" 2
.IX Item "message_type => $class"
.IP "multipart_type => CLASS" 2
.IX Item "multipart_type => CLASS"
.ie n .IP "password => $password" 2
.el .IP "password => \f(CW$password\fR" 2
.IX Item "password => $password"
.PD
The \f(CW$password\fR which is required to contact the remote server.
.IP "remove_when_empty => BOOLEAN" 2
.IX Item "remove_when_empty => BOOLEAN"
.PD 0
.IP "save_on_exit => BOOLEAN" 2
.IX Item "save_on_exit => BOOLEAN"
.ie n .IP "server_name => $host" 2
.el .IP "server_name => \f(CW$host\fR" 2
.IX Item "server_name => $host"
.PD
The name of the \f(CW$host\fR which contains the remote mail server.
.ie n .IP "server_port => $number" 2
.el .IP "server_port => \f(CW$number\fR" 2
.IX Item "server_port => $number"
Port \f(CW$number\fR in use by the server application.
.IP "trusted => BOOLEAN" 2
.IX Item "trusted => BOOLEAN"
.PD 0
.ie n .IP "username => $username" 2
.el .IP "username => \f(CW$username\fR" 2
.IX Item "username => $username"
.PD
The username which is to be used for the remote server.
.RE
.RS 4
.RE
.SS Attributes
.IX Subsection "Attributes"
Extends "Attributes" in Mail::Box.
.ie n .IP $obj\->\fBfixHeaders\fR() 4
.el .IP \f(CW$obj\fR\->\fBfixHeaders\fR() 4
.IX Item "$obj->fixHeaders()"
Inherited, see "Attributes" in Mail::Box
.ie n .IP "$obj\->\fBfolderdir\fR( [$directory] )" 4
.el .IP "\f(CW$obj\fR\->\fBfolderdir\fR( [$directory] )" 4
.IX Item "$obj->folderdir( [$directory] )"
Inherited, see "Attributes" in Mail::Box
.ie n .IP $obj\->\fBisTrusted\fR() 4
.el .IP \f(CW$obj\fR\->\fBisTrusted\fR() 4
.IX Item "$obj->isTrusted()"
Inherited, see "Attributes" in Mail::Box
.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"
Inherited, see "Attributes" in Mail::Box
.ie n .IP $obj\->\fBremoveEmpty\fR() 4
.el .IP \f(CW$obj\fR\->\fBremoveEmpty\fR() 4
.IX Item "$obj->removeEmpty()"
Inherited, see "Attributes" in Mail::Box
.ie n .IP $obj\->\fBtype\fR() 4
.el .IP \f(CW$obj\fR\->\fBtype\fR() 4
.IX Item "$obj->type()"
Inherited, see "Attributes" in Mail::Box
.SS "The folder"
.IX Subsection "The folder"
Extends "The folder" in Mail::Box.
.ie n .IP "$obj\->\fBaddMessage\fR($message, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBaddMessage\fR($message, \f(CW%options\fR)" 4
.IX Item "$obj->addMessage($message, %options)"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBaddMessages\fR(@messages) 4
.el .IP \f(CW$obj\fR\->\fBaddMessages\fR(@messages) 4
.IX Item "$obj->addMessages(@messages)"
Inherited, see "The folder" in Mail::Box
.ie n .IP $class\->\fBappendMessages\fR(%options) 4
.el .IP \f(CW$class\fR\->\fBappendMessages\fR(%options) 4
.IX Item "$class->appendMessages(%options)"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBclose\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBclose\fR(%options) 4
.IX Item "$obj->close(%options)"
Inherited, see "The folder" in Mail::Box
.ie n .IP "$obj\->\fBcopyTo\fR($folder, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBcopyTo\fR($folder, \f(CW%options\fR)" 4
.IX Item "$obj->copyTo($folder, %options)"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBdelete\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBdelete\fR(%options) 4
.IX Item "$obj->delete(%options)"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBorganization\fR() 4
.el .IP \f(CW$obj\fR\->\fBorganization\fR() 4
.IX Item "$obj->organization()"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBsize\fR() 4
.el .IP \f(CW$obj\fR\->\fBsize\fR() 4
.IX Item "$obj->size()"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBupdate\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBupdate\fR(%options) 4
.IX Item "$obj->update(%options)"
Inherited, see "The folder" in Mail::Box
.ie n .IP $obj\->\fBurl\fR() 4
.el .IP \f(CW$obj\fR\->\fBurl\fR() 4
.IX Item "$obj->url()"
Inherited, see "The folder" in Mail::Box
.SS "Folder flags"
.IX Subsection "Folder flags"
Extends "Folder flags" in Mail::Box.
.ie n .IP $obj\->\fBaccess\fR() 4
.el .IP \f(CW$obj\fR\->\fBaccess\fR() 4
.IX Item "$obj->access()"
Inherited, see "Folder flags" in Mail::Box
.ie n .IP $obj\->\fBisModified\fR() 4
.el .IP \f(CW$obj\fR\->\fBisModified\fR() 4
.IX Item "$obj->isModified()"
Inherited, see "Folder flags" in Mail::Box
.ie n .IP "$obj\->\fBmodified\fR( [BOOLEAN] )" 4
.el .IP "\f(CW$obj\fR\->\fBmodified\fR( [BOOLEAN] )" 4
.IX Item "$obj->modified( [BOOLEAN] )"
Inherited, see "Folder flags" in Mail::Box
.ie n .IP $obj\->\fBwritable\fR() 4
.el .IP \f(CW$obj\fR\->\fBwritable\fR() 4
.IX Item "$obj->writable()"
Inherited, see "Folder flags" in Mail::Box
.SS "The messages"
.IX Subsection "The messages"
Extends "The messages" in Mail::Box.
.ie n .IP "$obj\->\fBcurrent\fR( [$number|$message|$message_id] )" 4
.el .IP "\f(CW$obj\fR\->\fBcurrent\fR( [$number|$message|$message_id] )" 4
.IX Item "$obj->current( [$number|$message|$message_id] )"
Inherited, see "The messages" in Mail::Box
.ie n .IP $obj\->\fBfind\fR($message_id) 4
.el .IP \f(CW$obj\fR\->\fBfind\fR($message_id) 4
.IX Item "$obj->find($message_id)"
Inherited, see "The messages" in Mail::Box
.ie n .IP "$obj\->\fBfindFirstLabeled\fR( $label, [BOOLEAN, [\e@msgs]] )" 4
.el .IP "\f(CW$obj\fR\->\fBfindFirstLabeled\fR( \f(CW$label\fR, [BOOLEAN, [\e@msgs]] )" 4
.IX Item "$obj->findFirstLabeled( $label, [BOOLEAN, [@msgs]] )"
Inherited, see "The messages" in Mail::Box
.ie n .IP "$obj\->\fBmessage\fR( $index, [$message] )" 4
.el .IP "\f(CW$obj\fR\->\fBmessage\fR( \f(CW$index\fR, [$message] )" 4
.IX Item "$obj->message( $index, [$message] )"
Inherited, see "The messages" in Mail::Box
.ie n .IP "$obj\->\fBmessageId\fR( $message_id, [$message] )" 4
.el .IP "\f(CW$obj\fR\->\fBmessageId\fR( \f(CW$message_id\fR, [$message] )" 4
.IX Item "$obj->messageId( $message_id, [$message] )"
Inherited, see "The messages" in Mail::Box
.ie n .IP $obj\->\fBmessageIds\fR() 4
.el .IP \f(CW$obj\fR\->\fBmessageIds\fR() 4
.IX Item "$obj->messageIds()"
Inherited, see "The messages" in Mail::Box
.ie n .IP "$obj\->\fBmessages\fR( <\*(AqALL\*(Aq|$range|\*(AqACTIVE\*(Aq|\*(AqDELETED\*(Aq|$label| !$label|$filter> )" 4
.el .IP "\f(CW$obj\fR\->\fBmessages\fR( <\*(AqALL\*(Aq|$range|\*(AqACTIVE\*(Aq|\*(AqDELETED\*(Aq|$label| !$label|$filter> )" 4
.IX Item "$obj->messages( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )"
Inherited, see "The messages" in Mail::Box
.ie n .IP $obj\->\fBnrMessages\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBnrMessages\fR(%options) 4
.IX Item "$obj->nrMessages(%options)"
Inherited, see "The messages" in Mail::Box
.ie n .IP "$obj\->\fBscanForMessages\fR($message, $message_ids, $timespan, $window)" 4
.el .IP "\f(CW$obj\fR\->\fBscanForMessages\fR($message, \f(CW$message_ids\fR, \f(CW$timespan\fR, \f(CW$window\fR)" 4
.IX Item "$obj->scanForMessages($message, $message_ids, $timespan, $window)"
Inherited, see "The messages" in Mail::Box
.SS Sub\-folders
.IX Subsection "Sub-folders"
Extends "Sub\-folders" in Mail::Box.
.ie n .IP $any\->\fBlistSubFolders\fR(%options) 4
.el .IP \f(CW$any\fR\->\fBlistSubFolders\fR(%options) 4
.IX Item "$any->listSubFolders(%options)"
Inherited, see "Sub\-folders" in Mail::Box
.ie n .IP "$any\->\fBnameOfSubFolder\fR( $subname, [$parentname] )" 4
.el .IP "\f(CW$any\fR\->\fBnameOfSubFolder\fR( \f(CW$subname\fR, [$parentname] )" 4
.IX Item "$any->nameOfSubFolder( $subname, [$parentname] )"
Inherited, see "Sub\-folders" in Mail::Box
.ie n .IP $obj\->\fBopenRelatedFolder\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBopenRelatedFolder\fR(%options) 4
.IX Item "$obj->openRelatedFolder(%options)"
Inherited, see "Sub\-folders" in Mail::Box
.ie n .IP "$obj\->\fBopenSubFolder\fR($subname, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBopenSubFolder\fR($subname, \f(CW%options\fR)" 4
.IX Item "$obj->openSubFolder($subname, %options)"
Inherited, see "Sub\-folders" in Mail::Box
.ie n .IP $any\->\fBtopFolderWithMessages\fR() 4
.el .IP \f(CW$any\fR\->\fBtopFolderWithMessages\fR() 4
.IX Item "$any->topFolderWithMessages()"
Inherited, see "Sub\-folders" in Mail::Box
.SS Internals
.IX Subsection "Internals"
Extends "Internals" in Mail::Box.
.ie n .IP "$obj\->\fBcoerce\fR($message, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBcoerce\fR($message, \f(CW%options\fR)" 4
.IX Item "$obj->coerce($message, %options)"
Inherited, see "Internals" in Mail::Box
.ie n .IP "$any\->\fBcreate\fR($folder, %options)" 4
.el .IP "\f(CW$any\fR\->\fBcreate\fR($folder, \f(CW%options\fR)" 4
.IX Item "$any->create($folder, %options)"
Create a new folder on the remote server.
Improves base, see "Internals" in Mail::Box
.Sp
.Vb 2
\& \-Option   \-\-Defined in\-\-Default
\&  folderdir  Mail::Box   undef
.Ve
.RS 4
.ie n .IP "folderdir => $directory" 2
.el .IP "folderdir => \f(CW$directory\fR" 2
.IX Item "folderdir => $directory"
.RE
.RS 4
.RE
.ie n .IP "$obj\->\fBdetermineBodyType\fR($message, $head)" 4
.el .IP "\f(CW$obj\fR\->\fBdetermineBodyType\fR($message, \f(CW$head\fR)" 4
.IX Item "$obj->determineBodyType($message, $head)"
Inherited, see "Internals" in Mail::Box
.ie n .IP "$class\->\fBfoundIn\fR( [$foldername], %options )" 4
.el .IP "\f(CW$class\fR\->\fBfoundIn\fR( [$foldername], \f(CW%options\fR )" 4
.IX Item "$class->foundIn( [$foldername], %options )"
Inherited, see "Internals" in Mail::Box
.ie n .IP "$obj\->\fBlineSeparator\fR( [<STRING|\*(AqCR\*(Aq|\*(AqLF\*(Aq|\*(AqCRLF\*(Aq>] )" 4
.el .IP "\f(CW$obj\fR\->\fBlineSeparator\fR( [<STRING|\*(AqCR\*(Aq|\*(AqLF\*(Aq|\*(AqCRLF\*(Aq>] )" 4
.IX Item "$obj->lineSeparator( [<STRING|'CR'|'LF'|'CRLF'>] )"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBlocker\fR() 4
.el .IP \f(CW$obj\fR\->\fBlocker\fR() 4
.IX Item "$obj->locker()"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBread\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBread\fR(%options) 4
.IX Item "$obj->read(%options)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBreadMessages\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBreadMessages\fR(%options) 4
.IX Item "$obj->readMessages(%options)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBstoreMessage\fR($message) 4
.el .IP \f(CW$obj\fR\->\fBstoreMessage\fR($message) 4
.IX Item "$obj->storeMessage($message)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBtoBeThreaded\fR($messages) 4
.el .IP \f(CW$obj\fR\->\fBtoBeThreaded\fR($messages) 4
.IX Item "$obj->toBeThreaded($messages)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBtoBeUnthreaded\fR($messages) 4
.el .IP \f(CW$obj\fR\->\fBtoBeUnthreaded\fR($messages) 4
.IX Item "$obj->toBeUnthreaded($messages)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBupdateMessages\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBupdateMessages\fR(%options) 4
.IX Item "$obj->updateMessages(%options)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBwrite\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBwrite\fR(%options) 4
.IX Item "$obj->write(%options)"
Inherited, see "Internals" in Mail::Box
.ie n .IP $obj\->\fBwriteMessages\fR(%options) 4
.el .IP \f(CW$obj\fR\->\fBwriteMessages\fR(%options) 4
.IX Item "$obj->writeMessages(%options)"
Inherited, see "Internals" in Mail::Box
.SS "Other methods"
.IX Subsection "Other methods"
Extends "Other methods" in Mail::Box.
.ie n .IP $any\->\fBtimespan2seconds\fR($time) 4
.el .IP \f(CW$any\fR\->\fBtimespan2seconds\fR($time) 4
.IX Item "$any->timespan2seconds($time)"
Inherited, see "Other methods" in Mail::Box
.SS "Error handling"
.IX Subsection "Error handling"
Extends "Error handling" in Mail::Box.
.ie n .IP $obj\->\fBAUTOLOAD\fR() 4
.el .IP \f(CW$obj\fR\->\fBAUTOLOAD\fR() 4
.IX Item "$obj->AUTOLOAD()"
Inherited, see "Error handling" 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 "Error handling" in Mail::Reporter
.SS Cleanup
.IX Subsection "Cleanup"
Extends "Cleanup" in Mail::Box.
.ie n .IP $obj\->\fBDESTROY\fR() 4
.el .IP \f(CW$obj\fR\->\fBDESTROY\fR() 4
.IX Item "$obj->DESTROY()"
Inherited, see "Cleanup" in Mail::Box
.SH DETAILS
.IX Header "DETAILS"
Extends "DETAILS" in Mail::Box.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.ie n .IP "Error: Folder $name is opened read\-only" 4
.el .IP "Error: Folder \f(CW$name\fR is opened read\-only" 4
.IX Item "Error: Folder $name is opened read-only"
You can not write to this folder unless you have opened the folder to
write or append with new(access), or the \f(CW\*(C`force\*(C'\fR option is set \f(CW\*(C`true\*(C'\fR.
Cast by \f(CWwrite()\fR
.ie n .IP "Warning: changes not written to read\-only folder $name." 4
.el .IP "Warning: changes not written to read\-only folder \f(CW$name\fR." 4
.IX Item "Warning: changes not written to read-only folder $name."
You have opened the folder read\-only \-\-which is the default set
by new(access)\-\-, made modifications, and now want to close it.
Set close(force) if you want to overrule the access mode, or close
the folder with close(write) set to \f(CW\*(C`NEVER\*(C'\fR.
Cast by \f(CWclose()\fR
.ie n .IP "Error: class $package does not implement method $method." 4
.el .IP "Error: class \f(CW$package\fR does not implement method \f(CW$method\fR." 4
.IX Item "Error: class $package does not implement method $method."
Fatal error: the specific \f(CW$package\fR (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 \f(CWnotImplemented()\fR
.IP "Error: copying failed for one message." 4
.IX Item "Error: copying failed for one message."
For some reason, for instance disk full, removed by external process, or
read\-protection, it is impossible to copy one of the messages.  Copying will
proceed for the other messages.
Cast by \f(CWcopyTo()\fR
.ie n .IP "Error: destination folder $name is not writable." 4
.el .IP "Error: destination folder \f(CW$name\fR is not writable." 4
.IX Item "Error: destination folder $name is not writable."
The folder where the messages are copied to is not opened with write
access (see new(access)).  This has no relation with write permission
to the folder which is controlled by your operating system.
Cast by \f(CWcopyTo()\fR
.ie n .IP "Warning: different messages with id $msgid." 4
.el .IP "Warning: different messages with id \f(CW$msgid\fR." 4
.IX Item "Warning: different messages with id $msgid."
The message id is discovered more than once within the same folder, but the
content of the message seems to be different.  This should not be possible:
each message must be unique.
Cast by \f(CWmessageId()\fR
.ie n .IP "Warning: folder $name not deleted: not writable." 4
.el .IP "Warning: folder \f(CW$name\fR not deleted: not writable." 4
.IX Item "Warning: folder $name not deleted: not writable."
The folder must be opened with write access via new(access), otherwise
removing it will be refused.  So, you may have write\-access according to
the operating system, but that will not automatically mean that this
\&\f(CW\*(C`delete\*(C'\fR method permits you to.  The reverse remark is valid as well.
Cast by \f(CWdelete()\fR
.IP "Error: invalid timespan \*(Aq$span\*(Aq." 4
.IX Item "Error: invalid timespan '$span'."
The string does not follow the strict rules of the time span syntax which
is permitted as parameter.
Cast by \f(CWtimespan2seconds()\fR
.IP "Warning: message\-id \*(Aq$msgid\*(Aq does not contain a domain." 4
.IX Item "Warning: message-id '$msgid' does not contain a domain."
According to the RFCs, message\-ids need to contain a unique random part,
then an \f(CW\*(C`@\*(C'\fR, and then a domain name.  This is made to avoid the creation
of two messages with the same id.  The warning emerges when the \f(CW\*(C`@\*(C'\fR is
missing from the string.
Cast by \f(CWmessageId()\fR
.IP "Warning: the term \*(Aqhostname\*(Aq is confusing wrt folder. You probably need \*(Aqserver_name\*(Aq." 4
.IX Item "Warning: the term 'hostname' is confusing wrt folder. You probably need 'server_name'."
Cast by \f(CWnew()\fR
.ie n .IP "Error: unknown value to folder\->close(write => $when)." 4
.el .IP "Error: unknown value to folder\->close(write => \f(CW$when\fR)." 4
.IX Item "Error: unknown value to folder->close(write => $when)."
Cast by \f(CWclose()\fR
.IP "Error: you cannot add a message which is already part of a folder to a new one.  Please use moveTo or copyTo." 4
.IX Item "Error: you cannot add a message which is already part of a folder to a new one. Please use moveTo or copyTo."
Cast by \f(CWaddMessage()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail\-Box version 4.02,
built on April 10, 2026. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2001\-2026 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.