ImageData Property

This property optionally specifies the image data.

Syntax

 phtmlmailer.getImageData(index, [callback])
 phtmlmailer.setImageData(index,  imageData_Buffer, [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 getImageData([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setImageData([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 optionally specifies the image data. This may be used instead of specifying an image by file. The value specified here may be either the Hex encoded image data, or the raw un-encoded image data.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

This property is not available at design time.

Data Type

Buffer