MessagePartFilename Property

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

Syntax

 pimap.getMessagePartFilename(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 getMessagePartFilename([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 setMessagePartFilename([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 shows the filename corresponding to the part (if the part was included in the message as an attached file).

The index parameter specifies the index of the item in the array. 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