NotifyType Property

Identifies the set of valid email notification recipient types.

Syntax

 uspsship.getNotifyType(index, [callback])
 uspsship.setNotifyType(index,  notifyType, [callback])

Possible Values

  0 (rtUnspecified), 
  1 (rtRecipient), 
  2 (rtShipper), 
  3 (rtBroker), 
  4 (rtOther), 
  5 (rtThirdParty)

Default Value

0

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 getNotifyType([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 setNotifyType([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

Identifies the set of valid email notification recipient types. Valid values are:

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the NotifyEmail specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This property does not apply to UPS or Canada Post notifications.

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

This property is not available at design time.

Data Type

Integer