MessageText Property

The plain text version of the message.

Syntax

 phtmlmailer.getMessageText([callback])
 phtmlmailer.setMessageText( messageText, [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 getMessageText([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 setMessageText([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 is a plain text version of the HTML message. This is necessary for recipients with legacy mail readers that do not support HTML.

The MessageHTML property contains the HTML version of the message. When MessageHTML is set, the class automatically computes a plain text version of the text and puts it into this property. You may choose to override this default text with your own version.

Data Type

String