ListSubscribedMailboxes Method

Lists all subscribed mailboxes matching all criteria in the Mailbox property.

Syntax

pimap.listSubscribedMailboxes([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 lists all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.

Example (List All Subscribed Mailboxes)

IMAPControl.Mailbox = "*"
IMAPControl.ListSubscribedMailboxes()

Example (List All Subscribed Mailboxes Inside INBOX)

IMAPControl.Mailbox = "INBOX.*"
IMAPControl.ListSubscribedMailboxes()