ReceiptDeliveryOption Property

A URL indicating how the receipt is to be delivered.

Syntax

 as2receiver.getReceiptDeliveryOption([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 getReceiptDeliveryOption([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 setReceiptDeliveryOption([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 corresponds to the Receipt-delivery-option header in Request. If nonempty, the client has requested that the receipt be sent to the URL specified asynchronously. If empty, the receipt is to be delivered synchronously in the HTTP reply. In either case the receipt may be delivered by invoking SendResponse.

ReceiptDeliveryOption does not indicate whether or not a receipt was actually requested. If an MDN was requested, that information is given in MDNTo.

This property is read-only.

Data Type

String