RecipientKeyCount Property
The number of records in the RecipientKey arrays.
Syntax
phtmlmailer.getRecipientKeyCount([callback]) phtmlmailer.setRecipientKeyCount( recipientKeyCount, [callback])
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 getRecipientKeyCount([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 setRecipientKeyCount([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 controls the size of the following arrays:
The array indices start at 0 and end at RecipientKeyCount - 1.This property is not available at design time.
Data Type
Integer