Importance Property

Importance of the mail message (optional).

Syntax

 phtmlmailer.getImportance([callback])
 phtmlmailer.setImportance( importance, [callback])

Possible Values

  0 (miUnspecified), 
  1 (miHigh), 
  2 (miNormal), 
  3 (miLow)

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 getImportance([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 setImportance([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 indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.

Importance is an indication to the recipient(s) about how important the message is. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

Data Type

Integer