Class CreateDomainOptions

Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either HTTP or SMTP type. The type of domain determines which inboxes can be used with it. SMTP inboxes use a mail server running mxslurp.click while HTTP inboxes are handled by AWS SES.

Inheritance

object

CreateDomainOptions

Implements

IEquatable<CreateDomainOptions>

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 = "CreateDomainOptions")]
public class CreateDomainOptions : IEquatable<CreateDomainOptions>, IValidatableObject

Constructors

View Source

CreateDomainOptions()

Initializes a new instance of the CreateDomainOptions class.

Declaration

[JsonConstructor]
protected CreateDomainOptions()

View Source

CreateDomainOptions(string, string, bool?, DomainTypeEnum?)

Initializes a new instance of the CreateDomainOptions class.

Declaration

public CreateDomainOptions(string domain = null, string description = null, bool? createdCatchAllInbox = null, CreateDomainOptions.DomainTypeEnum? domainType = null)

Parameters

Type	Name	Description
string	domain	The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain. (required).
string	description	Optional description of the domain..
bool?	createdCatchAllInbox	Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID..
CreateDomainOptions.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..

Properties

View Source

CreatedCatchAllInbox

Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.

Declaration

[DataMember(Name = "createdCatchAllInbox", EmitDefaultValue = true)]
public bool? CreatedCatchAllInbox { get; set; }

Property Value

Type	Description
bool?	Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.

View Source

Description

Optional description of the domain.

Declaration

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

Property Value

Type	Description
string	Optional description of the domain.

View Source

Domain

The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So test.com covers all subdomains such as mail.test.com. Don't include a protocol such as http://. Once added you must complete the verification steps by adding the returned records to your domain.

Declaration

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

Property Value

Type	Description
string	The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.

View Source

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", EmitDefaultValue = true)]
public CreateDomainOptions.DomainTypeEnum? DomainType { get; set; }

Property Value

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

Methods

View Source

Equals(CreateDomainOptions)

Returns true if CreateDomainOptions instances are equal

Declaration

public bool Equals(CreateDomainOptions input)

Parameters

Type	Name	Description
CreateDomainOptions	input	Instance of CreateDomainOptions to be compared

Returns

Type	Description
bool	Boolean

View Source

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)

View Source

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

View Source

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

View Source

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()

View Source

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