IPWorks S/MIME 2020 Node.js Edition

Questions / Feedback?

IncludeCertificate Property

Specifies whether to include the signer's certificate with the signed message.

Syntax

 snntp.getIncludeCertificate([callback])
 snntp.setIncludeCertificate( includeCertificate, [callback])

Default Value

TRUE

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 getIncludeCertificate([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 setIncludeCertificate([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 this property is set to True, the certificate used to sign the message will be encoded and included in message signature when calling Sign or SignAndEncrypt.

Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 Node.js Edition - Version 20.0 [Build 8154]