MailboxStatus Event

Reports the mailbox status returned from the server.

Syntax

imapclient.on('MailboxStatus', [callback])

Callback

The 'callback' is called when the 'MailboxStatus' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.name
e.totalMessages
e.recentMessages
e.unseenMessages
e.nextUID
e.UIDValidity

Remarks

Subscribe to this event to be notified of mailbox status as returned by the IMAP server.