$client->encryption
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The OpenPGP public keys that let senders seal mail to your addresses: list the ones you published, publish or rotate one, and look up the keys of recipients before sealing a message.
encryption->listKeys
List your published encryption keys
listKeys(?string $apiKey = null): arrayReturns every OpenPGP public key published for an address in this workspace, newest first, the Encryption page of the app. Retired keys are included, with revokedAt and revokedReason set, and the live key of each address has revokedAt null.
Published keys belong to a person. A key reads and publishes the keys of the workspace owner, and an access token those of the person who connected the app. A key limited to particular addresses lists only the keys of those addresses.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
A list of arrays, each with id, address, fingerprint, publicKey, algorithm, createdAt, revokedAt and revokedReason.
Example
$keys = $client->encryption->listKeys(); foreach ($keys as $key) { $state = $key['revokedAt'] === null ? 'live' : 'retired'; echo $key['address'], ' ', $key['fingerprint'], ' ', $state, PHP_EOL;}Notes
Only public keys travel through the API. The private key stays on the device that made it.
Also available in
encryption->publishKey
Publish a public key for one of your addresses
publishKey(array $body, ?string $apiKey = null): arrayPublishes an armored OpenPGP public key for one of your addresses, so that senders can seal mail to it, as Publish on the Encryption page does. The address has to be an address of this workspace on a verified domain, switched on, and one you may use.
An address keeps one live key. To rotate, pass the fingerprint of the live key as replaces: it is retired as the new key is published. Mail already sealed to the old key stays readable only with the old private key.
Published keys belong to a person. A key reads and publishes the keys of the workspace owner, and an access token those of the person who connected the app.
Parameters
addressstringRequiredThe address the key is for.
publicKeystringRequiredThe armored OpenPGP PUBLIC KEY BLOCK, up to 64 KB.
fingerprintstringRequiredThe fingerprint of the key, 40 upper-case hexadecimal characters.
algorithmstringThe algorithm of the key, such as
ed25519, for display only.replacesstringThe fingerprint of the live key this one replaces, to rotate it.
apiKeystringOverrides the client's API key for this call only.
Returns
An array for the key, now live, with the same fields as each entry of encryption->listKeys.
Example
$armored = <<<'KEY' -----BEGIN PGP PUBLIC KEY BLOCK----- mDMEZk3x8RYJKwYBBAHaRw8BAQdA1n3cG0s7t2x0uVYw8Wq3m2Jb6p9vV5k4sQ1n =q8Xz -----END PGP PUBLIC KEY BLOCK----- KEY; $key = $client->encryption->publishKey([ 'address' => '[email protected]', 'publicKey' => $armored, 'fingerprint' => '3F2A9C1B7E4D5F60A1B2C3D4E5F60718293A4B5C', 'algorithm' => 'ed25519',]); echo $key['id'], ' ', $key['fingerprint'], PHP_EOL;Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.A second key while one is live, without
replaces, is 409key_already_published, and so is a key that was published for the address before. An address on a domain that is not verified yet is 409domain_not_verified, and an address you may not use is 403address_not_allowed.The SDK does not retry it.
Also available in
encryption->lookupKeys
Find the keys to seal mail to
lookupKeys(array|string $addresses, ?string $apiKey = null): arrayReturns the live public keys published for each recipient address, the lookup the composer makes before it seals a message. An address with no key comes back with keys empty, so mail to it cannot be sealed. Only keys published by somebody who can read the address count.
Parameters
addressesstring|string[]RequiredRecipient addresses, at most 51, as an array or one comma-separated string. They are sent comma-separated.
apiKeystringOverrides the client's API key for this call only.
Returns
A list of arrays, one per address, each with address and keys, every key an array with fingerprint, publicKey and createdAt.
Example
$found = $client->encryption->lookupKeys(['[email protected]', '[email protected]']); foreach ($found as $entry) { echo $entry['address'], ': ', $entry['keys'] === [] ? 'cannot be sealed' : 'can be sealed', PHP_EOL;}Notes
A display name in angle brackets is read as its address.