Gmail API . users . settings . sendAs . smimeInfo

Instance Methods

delete(userId, sendAsEmail, id)

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

get(userId, sendAsEmail, id)

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

insert(userId, sendAsEmail, body)

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

list(userId, sendAsEmail)

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

setDefault(userId, sendAsEmail, id)

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

Method Details

delete(userId, sendAsEmail, id)
Deletes the specified S/MIME config for the specified send-as alias.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
  id: string, The immutable ID for the SmimeInfo. (required)
get(userId, sendAsEmail, id)
Gets the specified S/MIME config for the specified send-as alias.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
  id: string, The immutable ID for the SmimeInfo. (required)

Returns:
  An object of the form:

    { # An S/MIME email config.
      "pkcs12": "A String", # 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.
      "pem": "A 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).
      "issuerCn": "A String", # The S/MIME certificate issuer's common name.
      "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
      "id": "A String", # The immutable ID for the SmimeInfo.
      "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
      "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
    }
insert(userId, sendAsEmail, body)
Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An S/MIME email config.
    "pkcs12": "A String", # 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.
    "pem": "A 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).
    "issuerCn": "A String", # The S/MIME certificate issuer's common name.
    "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
    "id": "A String", # The immutable ID for the SmimeInfo.
    "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
    "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
  }


Returns:
  An object of the form:

    { # An S/MIME email config.
      "pkcs12": "A String", # 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.
      "pem": "A 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).
      "issuerCn": "A String", # The S/MIME certificate issuer's common name.
      "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
      "id": "A String", # The immutable ID for the SmimeInfo.
      "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
      "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
    }
list(userId, sendAsEmail)
Lists S/MIME configs for the specified send-as alias.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)

Returns:
  An object of the form:

    {
    "smimeInfo": [ # List of SmimeInfo.
      { # An S/MIME email config.
          "pkcs12": "A String", # 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.
          "pem": "A 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).
          "issuerCn": "A String", # The S/MIME certificate issuer's common name.
          "encryptedKeyPassword": "A String", # Encrypted key password, when key is encrypted.
          "id": "A String", # The immutable ID for the SmimeInfo.
          "isDefault": True or False, # Whether this SmimeInfo is the default one for this user's send-as address.
          "expiration": "A String", # When the certificate expires (in milliseconds since epoch).
        },
    ],
  }
setDefault(userId, sendAsEmail, id)
Sets the default S/MIME config for the specified send-as alias.

Args:
  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
  sendAsEmail: string, The email address that appears in the "From:" header for mail sent using this alias. (required)
  id: string, The immutable ID for the SmimeInfo. (required)