RecipientAddress Property

This property contains the email address of a particular recipient.

Syntax

 smpp.getRecipientAddress(index, [callback])
 smpp.setRecipientAddress(index,  recipientAddress, [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 getRecipientAddress([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 setRecipientAddress([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 email address of a particular recipient. This can be used for setting single or multiple recipients. The RecipientType contains the corresponding type.

For a recipient type of normal, the value in the RecipientAddress should be either the dotted IPv4 of an SMS-enabled device or the directory number of a target mobile phone. For distributed lists, the value should be the name of the list as it is stored on the SMPPServer.

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

This property is not available at design time.

Data Type

String