EmailSubject Property

Subject for the email sent to recipients.

Syntax

 masspay.getEmailSubject([callback])
 masspay.setEmailSubject( emailSubject, [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 getEmailSubject([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 setEmailSubject([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

When a payment is made, the recipient will receive a notification email from PayPal. You can control the subject of that email with this property. However, you can only set one subject for all the payments you're sending in a Mass payment. You can not set a subject for each individual payment.

Data Type

String