HTMLFile Property

The path to a local HTML file.

Syntax

 phtmlmailer.getHTMLFile([callback])
 phtmlmailer.setHTMLFile( HTMLFile, [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 getHTMLFile([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 setHTMLFile([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 may contain the path to the local HTML file. If this property is not empty, the contents of the file with that name will be appended to the text in MessageHTML.

Note that this means that if MessageHTML is empty, HTMLFile is what will be sent to the server.

As a side effect, the current directory is set to the directory where MessageHTML is located.

This property is not available at design time.

Data Type

String