IPWorks S/MIME 2020 Node.js Edition

Questions / Feedback?

SignerCertChainEncoded Property

The certificate (PEM/base64 encoded).

Syntax

 simap.getSignerCertChainEncoded(index, [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 getSignerCertChainEncoded([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setSignerCertChainEncoded([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

The certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertChainStore and SignerCertChainSubject properties may also be used to specify a certificate.

When SignerCertChainEncoded is set, a search is initiated in the current SignerCertChainStore for the private key of the certificate. If the key is found, SignerCertChainSubject is updated to reflect the full subject of the selected certificate, otherwise SignerCertChainSubject is set to empty string.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

This property is read-only and not available at design time.

Data Type

Buffer

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