MessageRecipientOptions Property

This property contains the recipient sending options (used only by SMTP).

Syntax

 smtp.getMessageRecipientOptions(index, [callback])
 smtp.setMessageRecipientOptions(index,  messageRecipientOptions, [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 getMessageRecipientOptions([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 setMessageRecipientOptions([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 recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

One type of option is a delivery status notification sent per recipient which is specified by RFC 1891.

control.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY"

The size of the array is controlled by the MessageRecipientCount property.

This property is not available at design time.

Data Type

String