class UsersSettingsCseIdentities extends Resource (View source)

The "identities" collection of methods.

Typical usage is:

 $gmailService = new Google\Service\Gmail(...);
 $identities = $gmailService->users_settings_cse_identities;

Methods

create(string $userId, CseIdentity $postBody, array $optParams = [])

Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. (identities.create)

delete(string $userId, string $cseEmailAddress, array $optParams = [])

Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. (identities.delete)

get(string $userId, string $cseEmailAddress, array $optParams = [])

Retrieves a client-side encryption identity configuration. (identities.get)

listUsersSettingsCseIdentities(string $userId, array $optParams = [])

Lists the client-side encrypted identities for an authenticated user.

patch(string $userId, string $emailAddress, CseIdentity $postBody, array $optParams = [])

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles.

Details

CseIdentity create(string $userId, CseIdentity $postBody, array $optParams = [])

Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. (identities.create)

Parameters

string $userId

The requester's primary email address. To indicate the authenticated user, you can use the special value me.

CseIdentity $postBody
array $optParams

Optional parameters.

Return Value

CseIdentity

Exceptions

Exception

delete(string $userId, string $cseEmailAddress, array $optParams = [])

Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. (identities.delete)

Parameters

string $userId

The requester's primary email address. To indicate the authenticated user, you can use the special value me.

string $cseEmailAddress

The primary email address associated with the client-side encryption identity configuration that's removed.

array $optParams

Optional parameters.

Exceptions

Exception

CseIdentity get(string $userId, string $cseEmailAddress, array $optParams = [])

Retrieves a client-side encryption identity configuration. (identities.get)

Parameters

string $userId

The requester's primary email address. To indicate the authenticated user, you can use the special value me.

string $cseEmailAddress

The primary email address associated with the client-side encryption identity configuration that's retrieved.

array $optParams

Optional parameters.

Return Value

CseIdentity

Exceptions

Exception

ListCseIdentitiesResponse listUsersSettingsCseIdentities(string $userId, array $optParams = [])

Lists the client-side encrypted identities for an authenticated user.

(identities.listUsersSettingsCseIdentities)

Parameters

string $userId

The requester's primary email address. To indicate the authenticated user, you can use the special value me.

array $optParams

Optional parameters.

Return Value

ListCseIdentitiesResponse

Exceptions

Exception

CseIdentity patch(string $userId, string $emailAddress, CseIdentity $postBody, array $optParams = [])

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles.

(identities.patch)

Parameters

string $userId

The requester's primary email address. To indicate the authenticated user, you can use the special value me.

string $emailAddress

The email address of the client-side encryption identity to update.

CseIdentity $postBody
array $optParams

Optional parameters.

Return Value

CseIdentity

Exceptions

Exception