Class DomainDto

Domain plus verification records and status

Inheritance

object

DomainDto

Implements

IEquatable<DomainDto>

System.ComponentModel.DataAnnotations.IValidatableObject

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "DomainDto")]
public class DomainDto : IEquatable<DomainDto>, IValidatableObject

Constructors

DomainDto()

Initializes a new instance of the DomainDto class.

Declaration

[JsonConstructor]
protected DomainDto()

DomainDto(Guid, Guid, string, string, List<string>, string, bool, bool, List<DomainNameRecord>, Guid?, DateTime, DateTime, DomainTypeEnum)

Initializes a new instance of the DomainDto class.

Declaration

public DomainDto(Guid id = default, Guid userId = default, string domain = null, string verificationToken = null, List<string> dkimTokens = null, string missingRecordsMessage = null, bool hasMissingRecords = false, bool isVerified = false, List<DomainNameRecord> domainNameRecords = null, Guid? catchAllInboxId = null, DateTime createdAt = default, DateTime updatedAt = default, DomainDto.DomainTypeEnum domainType = (DomainDto.DomainTypeEnum)0)

Parameters

Type	Name	Description
System.Guid	id	id (required).
System.Guid	userId	userId (required).
string	domain	Custom domain name (required).
string	verificationToken	Verification tokens (required).
System.Collections.Generic.List<T><string>	dkimTokens	Unique token DKIM tokens (required).
string	missingRecordsMessage	If the domain is missing records then show which pairs are missing..
bool	hasMissingRecords	Whether the domain has missing required records. If true then see the domain in the dashboard app. (required).
bool	isVerified	Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records. (required).
System.Collections.Generic.List<T><DomainNameRecord>	domainNameRecords	List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider. (required).
System.Guid?	catchAllInboxId	The optional catch all inbox that will receive emails sent to the domain that cannot be matched..
DateTime	createdAt	createdAt (required).
DateTime	updatedAt	updatedAt (required).
DomainDto.DomainTypeEnum	domainType	Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails. (required).

Properties

CatchAllInboxId

The optional catch all inbox that will receive emails sent to the domain that cannot be matched.

Declaration

[DataMember(Name = "catchAllInboxId", EmitDefaultValue = true)]
public Guid? CatchAllInboxId { get; set; }

Property Value

Type	Description
System.Guid?	The optional catch all inbox that will receive emails sent to the domain that cannot be matched.

CreatedAt

Gets or Sets CreatedAt

Declaration

[DataMember(Name = "createdAt", IsRequired = true, EmitDefaultValue = true)]
public DateTime CreatedAt { get; set; }

Property Value

Type	Description
DateTime

DkimTokens

Unique token DKIM tokens

Declaration

[DataMember(Name = "dkimTokens", IsRequired = true, EmitDefaultValue = true)]
public List<string> DkimTokens { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<T><string>	Unique token DKIM tokens

Domain

Custom domain name

Declaration

[DataMember(Name = "domain", IsRequired = true, EmitDefaultValue = true)]
public string Domain { get; set; }

Property Value

Type	Description
string	Custom domain name

DomainNameRecords

List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.

Declaration

[DataMember(Name = "domainNameRecords", IsRequired = true, EmitDefaultValue = true)]
public List<DomainNameRecord> DomainNameRecords { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<T><DomainNameRecord>	List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.

DomainType

Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.

Declaration

[DataMember(Name = "domainType", IsRequired = true, EmitDefaultValue = true)]
public DomainDto.DomainTypeEnum DomainType { get; set; }

Property Value

Type	Description
DomainDto.DomainTypeEnum	Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.

HasMissingRecords

Whether the domain has missing required records. If true then see the domain in the dashboard app.

Declaration

[DataMember(Name = "hasMissingRecords", IsRequired = true, EmitDefaultValue = true)]
public bool HasMissingRecords { get; set; }

Property Value

Type	Description
bool	Whether the domain has missing required records. If true then see the domain in the dashboard app.

Id

Gets or Sets Id

Declaration

[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
public Guid Id { get; set; }

Property Value

Type	Description
System.Guid

IsVerified

Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.

Declaration

[DataMember(Name = "isVerified", IsRequired = true, EmitDefaultValue = true)]
public bool IsVerified { get; set; }

Property Value

Type	Description
bool	Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.

MissingRecordsMessage

If the domain is missing records then show which pairs are missing.

Declaration

[DataMember(Name = "missingRecordsMessage", EmitDefaultValue = true)]
public string MissingRecordsMessage { get; set; }

Property Value

Type	Description
string	If the domain is missing records then show which pairs are missing.

UpdatedAt

Gets or Sets UpdatedAt

Declaration

[DataMember(Name = "updatedAt", IsRequired = true, EmitDefaultValue = true)]
public DateTime UpdatedAt { get; set; }

Property Value

Type	Description
DateTime

UserId

Gets or Sets UserId

Declaration

[DataMember(Name = "userId", IsRequired = true, EmitDefaultValue = true)]
public Guid UserId { get; set; }

Property Value

Type	Description
System.Guid

VerificationToken

Verification tokens

Declaration

[DataMember(Name = "verificationToken", IsRequired = true, EmitDefaultValue = true)]
public string VerificationToken { get; set; }

Property Value

Type	Description
string	Verification tokens

Methods

Equals(DomainDto)

Returns true if DomainDto instances are equal

Declaration

public bool Equals(DomainDto input)

Parameters

Type	Name	Description
DomainDto	input	Instance of DomainDto to be compared

Returns

Type	Description
bool	Boolean

Equals(object)

Returns true if objects are equal

Declaration

public override bool Equals(object input)

Parameters

Type	Name	Description
object	input	Object to be compared

Returns

Type	Description
bool	Boolean

Overrides

Object.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Validate(ValidationContext)

To validate all properties of the instance

Declaration

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

Parameters

Type	Name	Description
ValidationContext	validationContext	Validation context

Returns

Type	Description
IEnumerable<ValidationResult>	Validation Result

Implements

System.IEquatable<T>

System.ComponentModel.DataAnnotations.IValidatableObject