NonDeliveryOption Property

Indicates what to do with the package in case it is undeliverable.

Syntax

 uspsshipintl.getNonDeliveryOption([callback])
 uspsshipintl.setNonDeliveryOption( nonDeliveryOption, [callback])

Possible Values

  0 (ndoReturn), 
  1 (ndoRedirect), 
  2 (ndoAbandon)

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 getNonDeliveryOption([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 setNonDeliveryOption([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

In case the package is undeliverable, the package may be returned, redirected, or abandoned. NonDeliveryOption should be set to ndoReturn in order for the package to be returned to the sender's address.

However, if NonDeliveryOption is set to ndoRedirect, the package will be redirected to the address specified in the following configuration settings:

AltReturnAddress1, AltReturnAddress2, AltReturnAddress3, AltReturnAddress4, AltReturnAddress5, AltReturnAddress6, AltReturnCountry.

This property is not applicable for International First Class mail, and will be ignored for International Priority and Express mail when the PackageType indicates a Flat Rate envelope is being used.

Data Type

Integer