NAME

$obj->addMessages(MESSAGE [, MESSAGE, ...])

Mail::Box::IMAP4->appendMessages(OPTIONS)

$obj->close(OPTIONS)

Close the folder. In the case of IMAP, more than one folder can use the same connection, therefore, closing a folder does not always close the connection to the server. Only when no folder is using the connection anymore, a logout will be invoked by Mail::Transport::IMAP4::DESTROY()

-Option      --Defined in     --Default
 force         Mail::Box        <false>
 save_deleted  Mail::Box        false
 write         Mail::Box        MODIFIED

force => BOOLEAN
save_deleted => BOOLEAN
write => 'ALWAYS'|'NEVER'|'MODIFIED'

$obj->copyTo(FOLDER, OPTIONS)

$obj->delete(OPTIONS)

$obj->folderdir([DIRECTORY])

See "METHODS" in Mail::Box::Net

$obj->name

$obj->organization

$obj->size

$obj->type

$obj->update(OPTIONS)

$obj->url

Folder flags

$obj->access: See "Folder flags" in Mail::Box
$obj->isModified: See "Folder flags" in Mail::Box
$obj->modified([BOOLEAN]): See "Folder flags" in Mail::Box
$obj->writable: See "Folder flags" in Mail::Box

The messages

$obj->current([NUMBER|MESSAGE|MESSAGE-ID]): See "The messages" in Mail::Box
$obj->find(MESSAGE-ID): See "The messages" in Mail::Box
$obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]]): See "The messages" in Mail::Box
$obj->message(INDEX [,MESSAGE]): See "The messages" in Mail::Box
$obj->messageId(MESSAGE-ID [,MESSAGE]): See "The messages" in Mail::Box
$obj->messageIds: See "The messages" in Mail::Box
$obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER]): See "The messages" in Mail::Box
$obj->nrMessages(OPTIONS): See "The messages" in Mail::Box
$obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW): See "The messages" in Mail::Box

Sub-folders

$obj->listSubFolders(OPTIONS)

Mail::Box::IMAP4->listSubFolders(OPTIONS)

$obj->nameOfSubFolder(SUBNAME, [PARENTNAME])

Mail::Box::IMAP4->nameOfSubFolder(SUBNAME, [PARENTNAME])

$obj->openRelatedFolder(OPTIONS)

$obj->openSubFolder(SUBNAME, OPTIONS)

$obj->topFolderWithMessages

Mail::Box::IMAP4->topFolderWithMessages

Internals

$obj->body([BODY])

$obj->coerce(MESSAGE, OPTIONS)

$obj->create(FOLDER, OPTIONS)

Mail::Box::IMAP4->create(FOLDER, OPTIONS)

See "METHODS" in Mail::Box::Net

$obj->createTransporter(CLASS, OPTIONS)

Create a transporter object (an instance of Mail::Transport::IMAP4), where CLASS defines the exact object type. As OPTIONS, everything which is acceptable to a transporter initiation can be used (see Mail::Transport::IMAP4::new().

-Option         --Default
 join_connection  true

join_connection => BOOLEAN: See new(join_connection). When false, the connection will never be shared with other IMAP mail boxes.

$obj->determineBodyType(MESSAGE, HEAD)

$obj->fetch(ARRAY-OF-MESSAGES|MESSAGE-SELECTION, INFO)

Low-level data retreival about one or more messages via IMAP4 from the remote server. Some of this data may differ from the information which is stored in the message objects which are created by MailBox, so you should avoid the use of this method for your own purposes. The IMAP implementation provides some wrappers around this, providing the correct behavior.

An array of MESSAGES may be specified or some MESSAGE SELECTION, acceptable to Mail::Box::messages(). Examples of the latter are 'ALL', 'DELETED', or spam (messages labelled to contain spam).

The INFO contains one or more attributes as defined by the IMAP protocol. You have to read the full specs of the related RFCs to see these.

Mail::Box::IMAP4->foundIn([FOLDERNAME], OPTIONS)

$obj->getHead(MESSAGE)

Read the header for the specified message from the remote server. undef is returned in case the message disappeared.

$obj->getHeadAndBody(MESSAGE)

Read all data for the specified message from the remote server. Return head and body of the mesasge as list, or an empty list if the MESSAGE disappeared from the server.

$obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])

$obj->locker

$obj->read(OPTIONS)

$obj->readMessages(OPTIONS)

$obj->storeMessage(MESSAGE)

$obj->toBeThreaded(MESSAGES)

$obj->toBeUnthreaded(MESSAGES)

$obj->transporter([OBJECT])

Returns the object which is the interface to the IMAP4 protocol handler. The IMAP4 handler has the current folder selected. When an OBJECT is specified, it is set to be the transporter from that moment on. The OBJECT must extend Mail::Transport::IMAP4.

$obj->updateMessages(OPTIONS)

$obj->write(OPTIONS)

The IMAP protocol usually writes the data immediately to the remote server, because that's what the protocol wants. However, some options to new() may delay that to boost performance. This method will, when the folder is being closed, write that info after all.

-Option      --Defined in     --Default
 force         Mail::Box        <false>
 save_deleted                   <false>

force => BOOLEAN
save_deleted => BOOLEAN: You may be able to save the messages which are flagged for deletion now, but they will be removed anyway when the folder is closed.

$obj->writeMessages(OPTIONS)

-Option     --Defined in     --Default
 messages     Mail::Box        <required>
 transporter                   <required>

messages => ARRAY
transporter => OBJECT

Other methods

$obj->timespan2seconds(TIME)

Mail::Box::IMAP4->timespan2seconds(TIME)

See "Other methods" in Mail::Box

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::IMAP4->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Box::IMAP4->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Box::IMAP4->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings