ExamineMailbox Method

Selects a Mailbox (Read-only mode).

Syntax

pimap.examineMailbox([callback])

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 this 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 asks the server to select the mailbox specified in the Mailbox property in read-only mode.

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