REST Resource: users.settings.sendAs.smimeInfo
Stay organized with collections
Save and categorize content based on your preferences.
Resource: SmimeInfo
| 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 |
|
|
Deletes the specified S/MIME config for the specified send-as alias. |
|
|
Gets the specified S/MIME config for the specified send-as alias. |
|
|
Insert (upload) the given S/MIME config for the specified send-as alias. |
|
|
Lists S/MIME configs for the specified send-as alias. |
|
|
Sets the default S/MIME config for the specified send-as alias. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# REST Resource: users.settings.sendAs.smimeInfo\n\n- [Resource: SmimeInfo](#SmimeInfo)\n - [JSON representation](#SmimeInfo.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: SmimeInfo\n-------------------\n\nAn S/MIME email config.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"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`. } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The immutable ID for the SmimeInfo. |\n| `issuerCn` | `string` The S/MIME certificate issuer's common name. |\n| `isDefault` | `boolean` Whether this SmimeInfo is the default one for this user's send-as address. |\n| `expiration` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` When the certificate expires (in milliseconds since epoch). |\n| `encryptedKeyPassword` | `string` Encrypted key password, when key is encrypted. |\n| 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: ||\n| `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). |\n| `pkcs12` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` 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. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|\n| ### [delete](/workspace/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/delete) | Deletes the specified S/MIME config for the specified send-as alias. |\n| ### [get](/workspace/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/get) | Gets the specified S/MIME config for the specified send-as alias. |\n| ### [insert](/workspace/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/insert) | Insert (upload) the given S/MIME config for the specified send-as alias. |\n| ### [list](/workspace/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/list) | Lists S/MIME configs for the specified send-as alias. |\n| ### [setDefault](/workspace/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/setDefault) | Sets the default S/MIME config for the specified send-as alias. |"]]
