IPWorks S/MIME 2020 Node.js Edition

Questions / Feedback?

MessageEncrypted Property

Whether or not the current message is encrypted.

Syntax

 simap.getMessageEncrypted([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 getMessageEncrypted([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 setMessageEncrypted([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 whether or not the current message is encrypted. This property will return true if the current message appears to be encrypted, according to the value of MessageHeaders.

This property is read-only.

Data Type

Boolean

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