Class: Google::Apis::GmailV1::SmimeInfo

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

Overview

An S/MIME email config.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SmimeInfo

Returns a new instance of SmimeInfo



1221
1222
1223
# File 'generated/google/apis/gmail_v1/classes.rb', line 1221

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

Instance Attribute Details

#encrypted_key_passwordString

Encrypted key password, when key is encrypted. Corresponds to the JSON property encryptedKeyPassword

Returns:

  • (String)


1182
1183
1184
# File 'generated/google/apis/gmail_v1/classes.rb', line 1182

def encrypted_key_password
  @encrypted_key_password
end

#expirationString

When the certificate expires (in milliseconds since epoch). Corresponds to the JSON property expiration

Returns:

  • (String)


1187
1188
1189
# File 'generated/google/apis/gmail_v1/classes.rb', line 1187

def expiration
  @expiration
end

#idString

The immutable ID for the SmimeInfo. Corresponds to the JSON property id

Returns:

  • (String)


1192
1193
1194
# File 'generated/google/apis/gmail_v1/classes.rb', line 1192

def id
  @id
end

#is_defaultBoolean Also known as: is_default?

Whether this SmimeInfo is the default one for this user's send-as address. Corresponds to the JSON property isDefault

Returns:

  • (Boolean)


1197
1198
1199
# File 'generated/google/apis/gmail_v1/classes.rb', line 1197

def is_default
  @is_default
end

#issuer_cnString

The S/MIME certificate issuer's common name. Corresponds to the JSON property issuerCn

Returns:

  • (String)


1203
1204
1205
# File 'generated/google/apis/gmail_v1/classes.rb', line 1203

def issuer_cn
  @issuer_cn
end

#pemString

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). Corresponds to the JSON property pem

Returns:

  • (String)


1210
1211
1212
# File 'generated/google/apis/gmail_v1/classes.rb', line 1210

def pem
  @pem
end

#pkcs12String

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. Corresponds to the JSON property pkcs12

Returns:

  • (String)


1219
1220
1221
# File 'generated/google/apis/gmail_v1/classes.rb', line 1219

def pkcs12
  @pkcs12
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1226
1227
1228
1229
1230
1231
1232
1233
1234
# File 'generated/google/apis/gmail_v1/classes.rb', line 1226

def update!(**args)
  @encrypted_key_password = args[:encrypted_key_password] if args.key?(:encrypted_key_password)
  @expiration = args[:expiration] if args.key?(:expiration)
  @id = args[:id] if args.key?(:id)
  @is_default = args[:is_default] if args.key?(:is_default)
  @issuer_cn = args[:issuer_cn] if args.key?(:issuer_cn)
  @pem = args[:pem] if args.key?(:pem)
  @pkcs12 = args[:pkcs12] if args.key?(:pkcs12)
end