ImageFile Property

This property contains the name of the image files embedded into the HTML message.

Syntax

 phtmlmailer.getImageFile(index, [callback])
 phtmlmailer.setImageFile(index,  imageFile, [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 getImageFile([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 setImageFile([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 name of the image files embedded into the HTML message. This value is updated every time MessageHTML is set. You may change the file names prior to sending (e.g. if they don't point to valid files).

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

String