Skip to content

encrypt.md

Latest commit

 

History

History
31 lines (21 loc) · 1.02 KB

encrypt.md

File metadata and controls

31 lines (21 loc) · 1.02 KB
Raw

encrypt

Encrypt a UTF-8 string to a domain's RSA public key (SPKI/PEM), returning the at-rest envelope JSON ({v,keyAlg,fp,enc,iv,wrappedKey,ciphertext}). Hybrid scheme: a fresh AES-256-GCM content key wrapped with RSA-OAEP(SHA-256) — byte-compatible with MailKite's own at-rest encryption. Local, no network call.

Local — runs in the SDK, no network call.

Parameters

Field Type Required Description
plaintext string ✓ The UTF-8 string to encrypt (e.g. a message body you're about to store).
publicKey string ✓ The recipient domain's RSA public key in SPKI/PEM form (-----BEGIN PUBLIC KEY-----)…

Returns

string

Example

$res = $mk->encrypt([
    'plaintext' => 'Meet at noon.',
    'publicKey' => '-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0K1w0Qy4
-----END PUBLIC KEY-----',
]);

← All methods · Docs · mailkite.dev