MessageFlags Property

Contains the flags of the current message.

Syntax

 pimap.getMessageFlags([callback])
 pimap.setMessageFlags( messageFlags, [callback])

Default Value

""

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 getMessageFlags([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 setMessageFlags([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

This property contains the flags of the current message. It is also used to specify flags when AppendToMailbox is called.

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

Example (Setting MessageFlags)

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

This property is not available at design time.

Data Type

String