Gmail API

/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}

GET

users

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//settings/sendAs//smimeInfo/'

Response Example

{
  "encryptedKeyPassword": "string",
  "expiration": "string",
  "id": "string",
  "isDefault": true,
  "issuerCn": "string",
  "pem": "string",
  "pkcs12": "string"
}

Request

Path Params

userId

string

required

The user's email address. The special value me can be used to indicate the authenticated user.

sendAsEmail

string

required

The email address that appears in the "From:" header for mail sent using this alias.

string

required

The immutable ID for the SmimeInfo.

Responses

🟢200Successful response

application/json

Body

An S/MIME email config.

encryptedKeyPassword

string

optional

Encrypted key password, when key is encrypted.

expiration

string <int64>

optional

When the certificate expires (in milliseconds since epoch).

string

optional

The immutable ID for the SmimeInfo.

isDefault

boolean

optional

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

issuerCn

string

optional

The S/MIME certificate issuer's common name.

pem

string

optional

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 <byte>

optional

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.

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}

/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault