AddMessageFlags Method

Adds the specified flags to the messages specified by MessageSet .

Syntax

pimap.addMessageFlags(flags, [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 adds the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

Example (Setting Adding Message Flags)

IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")