REST Resource: users.settings.sendAs.smimeInfo

Resource: SmimeInfo

An S/MIME email config.

JSON representation
{
  "id": string,
  "issuerCn": string,
  "isDefault": boolean,
  "expiration": string,
  "encryptedKeyPassword": string,

  // Union field key can be only one of the following:
  "pem": string,
  "pkcs12": string
  // End of list of possible types for union field key.
}
Fields
id

string

The immutable ID for the SmimeInfo.

issuerCn

string

The S/MIME certificate issuer's common name.

isDefault

boolean

Whether this SmimeInfo is the default one for this user's send-as address.

expiration

string (int64 format)

When the certificate expires (in milliseconds since epoch).

encryptedKeyPassword

string

Encrypted key password, when key is encrypted.

Union field key. The S/MIME "key", which may consist of various combinations of the public key, private key, and certificate chain depending on the format expected and used. key can be only one of the following:
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

string (bytes format)

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.

A base64-encoded string.

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.

list

Lists S/MIME configs for the specified send-as alias.

setDefault

Sets the default S/MIME config for the specified send-as alias.