KeyPassphrase Property

The passphrase for the key's secret key (if any).

Object Oriented Interface

public function getKeyPassphrase();
public function setKeyPassphrase($value);

Procedural Interface

ipworksopenpgp_keymgr_get($res, 8 );
ipworksopenpgp_keymgr_set($res, 8, $value );

Default Value

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

AddUserId
SignUserId
ChangeExpirationDate
ChangePassphrase

When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:

Decrypt
Sign
SignAndEncrypt

This property is not available at design time.

Data Type

String