UIDMode Property

If true, permanent message identifiers are used instead of the default temporary identifiers.

Syntax

 imap.getUIDMode([callback])
 imap.setUIDMode( UIDMode, [callback])

Default Value

FALSE

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 getUIDMode([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 setUIDMode([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 if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If UIDMode is true, permanent message identifiers are used instead.

The IMAP protocol operations where UID mode is used are the following: COPY, FETCH, STORE, SEARCH.

This property is not available at design time.

Data Type

Boolean