EmailReturnPath¶
- class oci.email.models.EmailReturnPath(**kwargs)¶
Bases:
objectThe properties that define a Email Return Path
Attributes:
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
A constant which can be used with the lifecycle_state property of a EmailReturnPath.
Gets the cname_record_value of this EmailReturnPath.
Gets the compartment_id of this EmailReturnPath.
Gets the defined_tags of this EmailReturnPath.
Gets the description of this EmailReturnPath.
Gets the dns_subdomain_name of this EmailReturnPath.
Gets the freeform_tags of this EmailReturnPath.
[Required] Gets the id of this EmailReturnPath.
Gets the lifecycle_details of this EmailReturnPath.
Gets the lifecycle_state of this EmailReturnPath.
Gets the locks of this EmailReturnPath.
[Required] Gets the name of this EmailReturnPath.
[Required] Gets the parent_resource_id of this EmailReturnPath.
Gets the system_tags of this EmailReturnPath.
Gets the time_created of this EmailReturnPath.
Gets the time_updated of this EmailReturnPath.
Methods:
__init__(**kwargs)Initializes a new EmailReturnPath object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “FAILED”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a EmailReturnPath. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new EmailReturnPath 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 EmailReturnPath.
id (str) – The value to assign to the id property of this EmailReturnPath.
parent_resource_id (str) – The value to assign to the parent_resource_id property of this EmailReturnPath.
compartment_id (str) – The value to assign to the compartment_id property of this EmailReturnPath.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailReturnPath. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this EmailReturnPath.
description (str) – The value to assign to the description property of this EmailReturnPath.
dns_subdomain_name (str) – The value to assign to the dns_subdomain_name property of this EmailReturnPath.
cname_record_value (str) – The value to assign to the cname_record_value property of this EmailReturnPath.
time_created (datetime) – The value to assign to the time_created property of this EmailReturnPath.
time_updated (datetime) – The value to assign to the time_updated property of this EmailReturnPath.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EmailReturnPath.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EmailReturnPath.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EmailReturnPath.
locks (list[oci.email.models.ResourceLock]) – The value to assign to the locks property of this EmailReturnPath.
- property cname_record_value¶
Gets the cname_record_value of this EmailReturnPath. The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
- Returns
The cname_record_value of this EmailReturnPath.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this EmailReturnPath. The OCID of the compartment that contains this email return path.
- Returns
The compartment_id of this EmailReturnPath.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this EmailReturnPath. 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 EmailReturnPath.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this EmailReturnPath. The description of the email return path. Avoid entering confidential information.
- Returns
The description of this EmailReturnPath.
- Return type
str
- property dns_subdomain_name¶
Gets the dns_subdomain_name of this EmailReturnPath. The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
- Returns
The dns_subdomain_name of this EmailReturnPath.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this EmailReturnPath. 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 EmailReturnPath.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this EmailReturnPath. The OCID of the email return path.
- Returns
The id of this EmailReturnPath.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this EmailReturnPath. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in ‘Failed’ state.
- Returns
The lifecycle_details of this EmailReturnPath.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this EmailReturnPath. The current state of the email return path.
Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this EmailReturnPath.
- Return type
str
- property locks¶
Gets the locks of this EmailReturnPath. Locks associated with this resource.
- Returns
The locks of this EmailReturnPath.
- Return type
- property name¶
[Required] Gets the name of this EmailReturnPath. The email return path domain in the Internet Domain Name System (DNS).
Example: iad1.rp.example.com
- Returns
The name of this EmailReturnPath.
- Return type
str
- property parent_resource_id¶
[Required] Gets the parent_resource_id of this EmailReturnPath. The OCID of the EmailDomain that this email return path belongs to.
- Returns
The parent_resource_id of this EmailReturnPath.
- Return type
str
- property system_tags¶
Gets the system_tags of this EmailReturnPath. 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 EmailReturnPath.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this EmailReturnPath. The time the email return path was created. Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
Example: 2021-02-12T22:47:12.613Z
- Returns
The time_created of this EmailReturnPath.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this EmailReturnPath. The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
- Returns
The time_updated of this EmailReturnPath.
- Return type
datetime