Class EmailDomainSummary

The properties that define an email domain. An email domain contains configuration used to assert responsibility for emails sent from that domain.

Inheritance
object
EmailDomainSummary
Inherited Members
Namespace: Oci.EmailService.Models
Assembly: OCI.DotNetSDK.Email.dll
Syntax
public class EmailDomainSummary

Properties

ActiveDkimId

Declaration
[JsonProperty(PropertyName = "activeDkimId")]
public string ActiveDkimId { get; set; }
Property Value
Type Description
string

The OCID of the DKIM key that is adding the DKIM signature for this email domain.

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains this email domain.

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 an email domain.

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 domain.
Remarks

Required

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public EmailDomain.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
EmailDomain.LifecycleStateEnum?

The current state of the email domain.

Name

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

The name of the email domain in the Internet Domain Name System (DNS).
Example: mydomain.example.com
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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".
Example: 2021-02-12T22:47:12.613Z