Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace EmailReturnPath

The properties that define a Email Return Path

Properties

Optional cnameRecordValue

cnameRecordValue: undefined | string

The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).

Optional compartmentId

compartmentId: undefined | string

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

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

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

Optional dnsSubdomainName

dnsSubdomainName: undefined | string

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.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the email return path.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the email return path.

name

name: string

The email return path domain in the Internet Domain Name System (DNS).

Example: {@code iad1.rp.example.com}

parentResourceId

parentResourceId: string

The OCID of the EmailDomain that this email return path belongs to.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

Example: {@code 2021-02-12T22:47:12.613Z}

Optional timeUpdated

timeUpdated: Date

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".

Functions

getDeserializedJsonObj

getJsonObj