EmailReturnPathSummary¶

class oci.email.models.EmailReturnPathSummary(**kwargs)¶

Bases: object

The properties that define a Email Return Path.

Methods

__init__(**kwargs) Initializes a new EmailReturnPathSummary object with values from keyword arguments.

Attributes

`compartment_id`	Gets the compartment_id of this EmailReturnPathSummary.
`defined_tags`	Gets the defined_tags of this EmailReturnPathSummary.
`description`	Gets the description of this EmailReturnPathSummary.
`freeform_tags`	Gets the freeform_tags of this EmailReturnPathSummary.
`id`	[Required] Gets the id of this EmailReturnPathSummary.
`lifecycle_state`	Gets the lifecycle_state of this EmailReturnPathSummary.
`name`	[Required] Gets the name of this EmailReturnPathSummary.
`parent_resource_id`	[Required] Gets the parent_resource_id of this EmailReturnPathSummary.
`system_tags`	Gets the system_tags of this EmailReturnPathSummary.
`time_created`	Gets the time_created of this EmailReturnPathSummary.
`time_updated`	Gets the time_updated of this EmailReturnPathSummary.

__init__(**kwargs)¶

Initializes a new EmailReturnPathSummary 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 EmailReturnPathSummary.
id (str) – The value to assign to the id property of this EmailReturnPathSummary.
parent_resource_id (str) – The value to assign to the parent_resource_id property of this EmailReturnPathSummary.
compartment_id (str) – The value to assign to the compartment_id property of this EmailReturnPathSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailReturnPathSummary.
description (str) – The value to assign to the description property of this EmailReturnPathSummary.
time_created (datetime) – The value to assign to the time_created property of this EmailReturnPathSummary.
time_updated (datetime) – The value to assign to the time_updated property of this EmailReturnPathSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EmailReturnPathSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EmailReturnPathSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EmailReturnPathSummary.

compartment_id¶

Gets the compartment_id of this EmailReturnPathSummary. The OCID of the compartment that contains this email return path.

Returns:	The compartment_id of this EmailReturnPathSummary.
Return type:	str

defined_tags¶

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

description¶

Gets the description of this EmailReturnPathSummary. The description of the email return path. Avoid entering confidential information.

Returns:	The description of this EmailReturnPathSummary.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this EmailReturnPathSummary. The OCID of the email return path.

Returns:	The id of this EmailReturnPathSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this EmailReturnPathSummary. The current state of the email return path.

Returns:	The lifecycle_state of this EmailReturnPathSummary.
Return type:	str

name¶

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

Example: iad1.rp.example.com

Returns:	The name of this EmailReturnPathSummary.
Return type:	str

parent_resource_id¶

[Required] Gets the parent_resource_id of this EmailReturnPathSummary. The OCID of the EmailDomain that this email return path belongs to.

Returns:	The parent_resource_id of this EmailReturnPathSummary.
Return type:	str

system_tags¶

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

time_created¶

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

time_updated¶

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