ASCIIArmor Property

Specifies whether to use ASCII armor to encode the output message.

Syntax

 openpgp.getASCIIArmor([callback])
 openpgp.setASCIIArmor( ASCIIArmor, [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 getASCIIArmor([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 setASCIIArmor([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 controls whether or not ASCII armoring is used on the output message. The default value is False.

Data Type

Boolean