Class: Google::Apis::GmailV1::CseIdentity

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gmail_v1/classes.rb,
lib/google/apis/gmail_v1/representations.rb,
lib/google/apis/gmail_v1/representations.rb

Overview

The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client- side encrypted email messages, and to sign and send encrypted email messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CseIdentity

Returns a new instance of CseIdentity.



197
198
199
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 197

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#email_address ⇒ String

The email address for the sending identity. The email address must be the primary email address of the authenticated user. Corresponds to the JSON property emailAddress

Returns:

  • (String) 


184
185
186
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 184

def email_address
  @email_address
end

#primary_key_pair_id ⇒ String

If a key pair is associated, the ID of the key pair, CseKeyPair. Corresponds to the JSON property primaryKeyPairId

Returns:

  • (String) 


189
190
191
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 189

def primary_key_pair_id
  @primary_key_pair_id
end

#sign_and_encrypt_key_pairs ⇒ Google::Apis::GmailV1::SignAndEncryptKeyPairs

The configuration of a CSE identity that uses different key pairs for signing and encryption. Corresponds to the JSON property signAndEncryptKeyPairs

Returns:



195
196
197
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 195

def sign_and_encrypt_key_pairs
  @sign_and_encrypt_key_pairs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



202
203
204
205
206
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 202

def update!(**args)
  @email_address = args[:email_address] if args.key?(:email_address)
  @primary_key_pair_id = args[:primary_key_pair_id] if args.key?(:primary_key_pair_id)
  @sign_and_encrypt_key_pairs = args[:sign_and_encrypt_key_pairs] if args.key?(:sign_and_encrypt_key_pairs)
end