Passphrase Property
Specifies a message decryption password.
Syntax
pgpreader.getPassphrase([callback]) pgpreader.setPassphrase( passphrase, [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 getPassphrase([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 setPassphrase([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
Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.
Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.
If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.
Data Type
String