CurrMailboxMessageFlags Property
Contains message flags defined in the mailbox.
Syntax
imapclient.getCurrMailboxMessageFlags([callback])
Default Value
0
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 getCurrMailboxMessageFlags([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 setCurrMailboxMessageFlags([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
Contains message flags defined in the mailbox.
imapMessageAnswered | 0x01 | Message has been answered. |
imapMessageDeleted | 0x02 | Message is 'deleted' for removal later. |
imapMessageDraft | 0x04 | Message has not completed composition (marked as a draft). |
imapMessageFlagged | 0x08 | Message is 'flagged' for urgent/special attention. |
imapMessageRecent | 0x10 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. |
imapMessageSeen | 0x20 | Message has been read. |
This property is read-only and not available at design time.
Data Type
Integer