CreateEmailReturnPathDetails¶

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

Bases: object

Properties to create a new email return path. The new object will be created in the same compartment as the parent resource.

Methods

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

Attributes

`defined_tags`	Gets the defined_tags of this CreateEmailReturnPathDetails.
`description`	Gets the description of this CreateEmailReturnPathDetails.
`freeform_tags`	Gets the freeform_tags of this CreateEmailReturnPathDetails.
`name`	Gets the name of this CreateEmailReturnPathDetails.
`parent_resource_id`	[Required] Gets the parent_resource_id of this CreateEmailReturnPathDetails.

__init__(**kwargs)¶

Initializes a new CreateEmailReturnPathDetails 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 CreateEmailReturnPathDetails.
parent_resource_id (str) – The value to assign to the parent_resource_id property of this CreateEmailReturnPathDetails.
description (str) – The value to assign to the description property of this CreateEmailReturnPathDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateEmailReturnPathDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateEmailReturnPathDetails.

defined_tags¶

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

description¶

Gets the description of this CreateEmailReturnPathDetails. A string that describes the details about the email return path. It does not have to be unique, and you can change it. Avoid entering confidential information.

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

freeform_tags¶

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

name¶

Gets the name of this CreateEmailReturnPathDetails. The name of the email return path domain in the Internet Domain Name System (DNS). The name must be a subdomain of the email domain used to send emails. The email return path name must be globally unique for this tenancy. If you do not provide the email return path name, we will generate one for you. If you do provide the email return path name, we suggest adding a short region indicator to allow using the same parent domain in other regions you might be subscribed to. Domain names limited to ASCII characters use alphanumeric, dash (“-“), and dot (“.”) characters. The dash and dot are only allowed between alphanumeric characters. Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

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

parent_resource_id¶

[Required] Gets the parent_resource_id of this CreateEmailReturnPathDetails. The OCID of the EmailDomain for this email return path.

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