MessageSet Property

The set of messages to operate on.

Syntax

 pimap.getMessageSet([callback])
 pimap.setMessageSet( messageSet, [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 getMessageSet([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 setMessageSet([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 indicates the set of messages to operate on. Used as an argument to most method calls.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

Example (Setting MessageSet)

IMAPControl.MessageSet = "1"
IMAPControl.FetchMessageInfo()

IMAPControl.MessageSet = "1:5"
IMAPControl.FetchMessageInfo()

IMAPControl.MessageSet = "1,5,7"
IMAPControl.FetchMessageInfo()

Data Type

String