EmailDomainSummary

class oci.email.models.EmailDomainSummary(**kwargs)

Bases: object

The properties that define an email domain. An email domain contains configuration used to assert responsibility for emails sent from that domain.

Methods:

__init__(**kwargs)

Initializes a new EmailDomainSummary object with values from keyword arguments.

Attributes:

active_dkim_id

Gets the active_dkim_id of this EmailDomainSummary.

compartment_id

Gets the compartment_id of this EmailDomainSummary.

defined_tags

Gets the defined_tags of this EmailDomainSummary.

description

Gets the description of this EmailDomainSummary.

freeform_tags

Gets the freeform_tags of this EmailDomainSummary.

id

[Required] Gets the id of this EmailDomainSummary.

lifecycle_state

Gets the lifecycle_state of this EmailDomainSummary.

locks

Gets the locks of this EmailDomainSummary.

name

[Required] Gets the name of this EmailDomainSummary.

system_tags

Gets the system_tags of this EmailDomainSummary.

time_created

Gets the time_created of this EmailDomainSummary.

__init__(**kwargs)

Initializes a new EmailDomainSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this EmailDomainSummary.

  • id (str) – The value to assign to the id property of this EmailDomainSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this EmailDomainSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailDomainSummary.

  • active_dkim_id (str) – The value to assign to the active_dkim_id property of this EmailDomainSummary.

  • description (str) – The value to assign to the description property of this EmailDomainSummary.

  • time_created (datetime) – The value to assign to the time_created property of this EmailDomainSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EmailDomainSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EmailDomainSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EmailDomainSummary.

  • locks (list[oci.email.models.ResourceLock]) – The value to assign to the locks property of this EmailDomainSummary.

property active_dkim_id

Gets the active_dkim_id of this EmailDomainSummary. The OCID of the DKIM key that is adding the DKIM signature for this email domain.

Returns

The active_dkim_id of this EmailDomainSummary.

Return type

str

property compartment_id

Gets the compartment_id of this EmailDomainSummary. The OCID of the compartment that contains this email domain.

Returns

The compartment_id of this EmailDomainSummary.

Return type

str

property defined_tags

Gets the defined_tags of this EmailDomainSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this EmailDomainSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this EmailDomainSummary. The description of an email domain.

Returns

The description of this EmailDomainSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this EmailDomainSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this EmailDomainSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this EmailDomainSummary. The OCID of the email domain.

Returns

The id of this EmailDomainSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this EmailDomainSummary. The current state of the email domain.

Returns

The lifecycle_state of this EmailDomainSummary.

Return type

str

property locks

Gets the locks of this EmailDomainSummary. Locks associated with this resource.

Returns

The locks of this EmailDomainSummary.

Return type

list[oci.email.models.ResourceLock]

property name

[Required] Gets the name of this EmailDomainSummary. The name of the email domain in the Internet Domain Name System (DNS).

Example: mydomain.example.com

Returns

The name of this EmailDomainSummary.

Return type

str

property system_tags

Gets the system_tags of this EmailDomainSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this EmailDomainSummary.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this EmailDomainSummary. The time the email domain was created, expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.

Example: 2021-02-12T22:47:12.613Z

Returns

The time_created of this EmailDomainSummary.

Return type

datetime