EmailDomain

class oci.email.models.EmailDomain(**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.

Attributes

DOMAIN_VERIFICATION_STATUS_DOMAINID A constant which can be used with the domain_verification_status property of a EmailDomain.
DOMAIN_VERIFICATION_STATUS_NONE A constant which can be used with the domain_verification_status property of a EmailDomain.
DOMAIN_VERIFICATION_STATUS_OTHER A constant which can be used with the domain_verification_status property of a EmailDomain.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a EmailDomain.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a EmailDomain.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a EmailDomain.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a EmailDomain.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a EmailDomain.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a EmailDomain.
active_dkim_id Gets the active_dkim_id of this EmailDomain.
compartment_id Gets the compartment_id of this EmailDomain.
defined_tags Gets the defined_tags of this EmailDomain.
description Gets the description of this EmailDomain.
domain_verification_id Gets the domain_verification_id of this EmailDomain.
domain_verification_status Gets the domain_verification_status of this EmailDomain.
freeform_tags Gets the freeform_tags of this EmailDomain.
id [Required] Gets the id of this EmailDomain.
is_spf Gets the is_spf of this EmailDomain.
lifecycle_state Gets the lifecycle_state of this EmailDomain.
name [Required] Gets the name of this EmailDomain.
system_tags Gets the system_tags of this EmailDomain.
time_created Gets the time_created of this EmailDomain.

Methods

__init__(**kwargs) Initializes a new EmailDomain object with values from keyword arguments.
DOMAIN_VERIFICATION_STATUS_DOMAINID = 'DOMAINID'

A constant which can be used with the domain_verification_status property of a EmailDomain. This constant has a value of “DOMAINID”

DOMAIN_VERIFICATION_STATUS_NONE = 'NONE'

A constant which can be used with the domain_verification_status property of a EmailDomain. This constant has a value of “NONE”

DOMAIN_VERIFICATION_STATUS_OTHER = 'OTHER'

A constant which can be used with the domain_verification_status property of a EmailDomain. This constant has a value of “OTHER”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a EmailDomain. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a EmailDomain. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a EmailDomain. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a EmailDomain. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a EmailDomain. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a EmailDomain. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new EmailDomain 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 EmailDomain.
  • id (str) – The value to assign to the id property of this EmailDomain.
  • compartment_id (str) – The value to assign to the compartment_id property of this EmailDomain.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailDomain. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • active_dkim_id (str) – The value to assign to the active_dkim_id property of this EmailDomain.
  • is_spf (bool) – The value to assign to the is_spf property of this EmailDomain.
  • domain_verification_status (str) – The value to assign to the domain_verification_status property of this EmailDomain. Allowed values for this property are: “NONE”, “DOMAINID”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • domain_verification_id (str) – The value to assign to the domain_verification_id property of this EmailDomain.
  • description (str) – The value to assign to the description property of this EmailDomain.
  • time_created (datetime) – The value to assign to the time_created property of this EmailDomain.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EmailDomain.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EmailDomain.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EmailDomain.
active_dkim_id

Gets the active_dkim_id of this EmailDomain. The OCID of the DKIM key that will be used to sign mail sent from this email domain.

Returns:The active_dkim_id of this EmailDomain.
Return type:str
compartment_id

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

Returns:The compartment_id of this EmailDomain.
Return type:str
defined_tags

Gets the defined_tags of this EmailDomain. 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 EmailDomain.
Return type:dict(str, dict(str, object))
description

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

Returns:The description of this EmailDomain.
Return type:str
domain_verification_id

Gets the domain_verification_id of this EmailDomain. Id for Domain in Domain Management (under governance) if DOMAINID verification method used.

Returns:The domain_verification_id of this EmailDomain.
Return type:str
domain_verification_status

Gets the domain_verification_status of this EmailDomain. The current domain verification status.

Allowed values for this property are: “NONE”, “DOMAINID”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The domain_verification_status of this EmailDomain.
Return type:str
freeform_tags

Gets the freeform_tags of this EmailDomain. 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 EmailDomain.
Return type:dict(str, str)
id

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

Returns:The id of this EmailDomain.
Return type:str
is_spf

Gets the is_spf of this EmailDomain. Value of the SPF field. For more information about SPF, please see SPF Authentication.

Returns:The is_spf of this EmailDomain.
Return type:bool
lifecycle_state

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

Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this EmailDomain.
Return type:str
name

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

Example: mydomain.example.com

Returns:The name of this EmailDomain.
Return type:str
system_tags

Gets the system_tags of this EmailDomain. 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 EmailDomain.
Return type:dict(str, dict(str, object))
time_created

Gets the time_created of this EmailDomain. 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 EmailDomain.
Return type:datetime