MessagePartId Property

This property contains the identifier of a part listing which may be identified in other parts or messages.

Syntax

 imap.getMessagePartId(index, [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 getMessagePartId([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 setMessagePartId([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 identifier of a part listing which may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.

The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

String