For a list of methods for this resource, see the end of this page.
Resource representations
An S/MIME email config.
{
"id": string,
"issuerCn": string,
"isDefault": boolean,
"expiration": long,
"pem": string,
"pkcs12": bytes,
"encryptedKeyPassword": string
}
| Property name | Value | Description | Notes |
|---|---|---|---|
encryptedKeyPassword |
string |
Encrypted key password, when key is encrypted. | |
expiration |
long |
When the certificate expires (in milliseconds since epoch). | |
id |
string |
The immutable ID for the SmimeInfo. | |
isDefault |
boolean |
Whether this SmimeInfo is the default one for this user's send-as address. | |
issuerCn |
string |
The S/MIME certificate issuer's common name. | |
pem |
string |
PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). | |
pkcs12 |
bytes |
PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. |
Methods
- delete
- Deletes the specified S/MIME config for the specified send-as alias.
- get
- Gets the specified S/MIME config for the specified send-as alias.
- insert
- Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.
- list
- Lists S/MIME configs for the specified send-as alias.
- setDefault
- Sets the default S/MIME config for the specified send-as alias.