com.google.api.services.gmail.model

Class SmimeInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.SmimeInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SmimeInfo
extends com.google.api.client.json.GenericJson

An S/MIME email config.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SmimeInfo()

Method Summary

Modifier and Type	Method and Description
SmimeInfo	clone()
byte[]	decodePkcs12() PKCS#12 format containing a single private/public key pair and certificate chain.
SmimeInfo	encodePkcs12(byte[] pkcs12) PKCS#12 format containing a single private/public key pair and certificate chain.
String	getEncryptedKeyPassword() Encrypted key password, when key is encrypted.
Long	getExpiration() When the certificate expires (in milliseconds since epoch).
String	getId() The immutable ID for the SmimeInfo.
Boolean	getIsDefault() Whether this SmimeInfo is the default one for this user's send-as address.
String	getIssuerCn() The S/MIME certificate issuer's common name.
String	getPem() PEM formatted X509 concatenated certificate string (standard base64 encoding).
String	getPkcs12() PKCS#12 format containing a single private/public key pair and certificate chain.
SmimeInfo	set(String fieldName, Object value)
SmimeInfo	setEncryptedKeyPassword(String encryptedKeyPassword) Encrypted key password, when key is encrypted.
SmimeInfo	setExpiration(Long expiration) When the certificate expires (in milliseconds since epoch).
SmimeInfo	setId(String id) The immutable ID for the SmimeInfo.
SmimeInfo	setIsDefault(Boolean isDefault) Whether this SmimeInfo is the default one for this user's send-as address.
SmimeInfo	setIssuerCn(String issuerCn) The S/MIME certificate issuer's common name.
SmimeInfo	setPem(String pem) PEM formatted X509 concatenated certificate string (standard base64 encoding).
SmimeInfo	setPkcs12(String pkcs12) PKCS#12 format containing a single private/public key pair and certificate chain.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SmimeInfo

public SmimeInfo()

Method Detail

getEncryptedKeyPassword

public String getEncryptedKeyPassword()

Encrypted key password, when key is encrypted.

Returns:

value or null for none

setEncryptedKeyPassword

public SmimeInfo setEncryptedKeyPassword(String encryptedKeyPassword)

Encrypted key password, when key is encrypted.

Parameters:

encryptedKeyPassword - encryptedKeyPassword or null for none

getExpiration

public Long getExpiration()

When the certificate expires (in milliseconds since epoch).

Returns:

value or null for none

setExpiration

public SmimeInfo setExpiration(Long expiration)

When the certificate expires (in milliseconds since epoch).

Parameters:

expiration - expiration or null for none

getId

public String getId()

The immutable ID for the SmimeInfo.

Returns:

value or null for none

setId

public SmimeInfo setId(String id)

The immutable ID for the SmimeInfo.

Parameters:

id - id or null for none

getIsDefault

public Boolean getIsDefault()

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

Returns:

value or null for none

setIsDefault

public SmimeInfo setIsDefault(Boolean isDefault)

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

Parameters:

isDefault - isDefault or null for none

getIssuerCn

public String getIssuerCn()

The S/MIME certificate issuer's common name.

Returns:

value or null for none

setIssuerCn

public SmimeInfo setIssuerCn(String issuerCn)

The S/MIME certificate issuer's common name.

Parameters:

issuerCn - issuerCn or null for none

getPem

public String getPem()

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).

Returns:

value or null for none

setPem

public SmimeInfo setPem(String pem)

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).

Parameters:

pem - pem or null for none

getPkcs12

public String getPkcs12()

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.

Returns:

value or null for none

See Also:

decodePkcs12()

decodePkcs12

public byte[] decodePkcs12()

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.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPkcs12()

setPkcs12

public SmimeInfo setPkcs12(String pkcs12)

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.

Parameters:

pkcs12 - pkcs12 or null for none

See Also:

#encodePkcs12()

encodePkcs12

public SmimeInfo encodePkcs12(byte[] pkcs12)

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.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

set

public SmimeInfo set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SmimeInfo clone()

Overrides:

clone in class com.google.api.client.json.GenericJson