Message Property

Provides a way to set the raw message content.

Syntax

 smtp.getMessage([callback])
 smtp.setMessage( message_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 getMessage([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 setMessage([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 be set instead of MessageText. The value set here will not be modified in any way by the class and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

This property is not available at design time.

Data Type

Buffer