IncludeHeaders Property

Tells the class whether to include the headers when encoding the message.

Syntax

 smime.getIncludeHeaders([callback])
 smime.setIncludeHeaders( includeHeaders, [callback])

Default Value

FALSE

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 getIncludeHeaders([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 setIncludeHeaders([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

If true, the class will include the headers when Sign, Encrypt, or SignAndEncrypt are called. If false, only the message will be encoded.

The default value for IncludeHeaders is false.

Data Type

Boolean