Class EmailReturnPath

The properties that define a Email Return Path

Inheritance

object

EmailReturnPath

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.EmailService.Models

Assembly: OCI.DotNetSDK.Email.dll

Syntax

public class EmailReturnPath

Properties

CnameRecordValue

Declaration

[JsonProperty(PropertyName = "cnameRecordValue")]
public string CnameRecordValue { get; set; }

Property Value

Type	Description
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).

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

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

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

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

DnsSubdomainName

Declaration

[JsonProperty(PropertyName = "dnsSubdomainName")]
public string DnsSubdomainName { get; set; }

Property Value

Type	Description
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.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the email return path.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
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.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public EmailReturnPath.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
EmailReturnPath.LifecycleStateEnum?	The current state of the email return path.

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com

Remarks

Required

ParentResourceId

Declaration

[Required(ErrorMessage = "ParentResourceId is required.")]
[JsonProperty(PropertyName = "parentResourceId")]
public string ParentResourceId { get; set; }

Property Value

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

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	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

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	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".