Mailbox Property

Name of the mailbox selected on the server.

Syntax

 imap.getMailbox([callback])
 imap.setMailbox( mailbox, [callback])

Default Value

"Inbox"

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getMailbox([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setMailbox([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method contains the name of the mailbox selected on the server, and is also used as argument to most methods. Please refer to the class methods for more information.

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder"
IMAPControl.ExamineMailbox

Data Type

String