Class CreateInboxDto

Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either SMTP or HTTP mailboxes. SMTP inboxes are processed by a mail server running at mailslurp.mx while HTTP inboxes are processed by AWS SES backed mailservers. An inbox email address is randomly assigned by default ending in either mailslurp.com or (if useDomainPool is enabled) ending in a similar domain such as mailslurp.xyz (selected at random). To specify an address use a custom domain: either pass the emailAddress options with <your-recipient>@<your-domain>. To create a randomized address for your domain set the domainName to the domain you have verified or pass the domainId. Virtual inboxes prevent outbound sending and instead trap mail.

Inheritance
object
CreateInboxDto
Implements
System.ComponentModel.DataAnnotations.IValidatableObject
Inherited Members
object.Equals(object, object)
object.MemberwiseClone()
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "CreateInboxDto")]
public class CreateInboxDto : IEquatable<CreateInboxDto>, IValidatableObject

Constructors

View Source

CreateInboxDto(string, string, Guid?, string, string, bool?, List<string>, DateTime?, bool?, long?, bool?, InboxTypeEnum?, bool?, bool?, string)

Initializes a new instance of the CreateInboxDto class.

Declaration
public CreateInboxDto(string emailAddress = null, string domainName = null, Guid? domainId = null, string name = null, string description = null, bool? useDomainPool = null, List<string> tags = null, DateTime? expiresAt = null, bool? favourite = null, long? expiresIn = null, bool? allowTeamAccess = null, CreateInboxDto.InboxTypeEnum? inboxType = null, bool? virtualInbox = null, bool? useShortAddress = null, string prefix = null)
Parameters
Type Name Description
string emailAddress

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as 123@mailslurp.com. If you use the useDomainPool option when the email address is null it will generate an email address with a more varied domain ending such as 123@mailslurp.info or 123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so SMTP inboxes will only work with SMTP type domains. Avoid SMTP inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID..
string domainName

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the emailAddress option instead to specify the full custom inbox..
System.Guid? domainId

ID of custom domain to use for email address..
string name

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails..
string description

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with.
bool? useDomainPool

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default @mailslurp.com email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in @mailslurp.{world,info,xyz,...} . This means a TLD is randomly selecting from a list of .biz, .info, .xyz etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of @mailslurp.com or custom email address provided by the emailAddress field. Note this feature is only available for HTTP inbox types..
System.Collections.Generic.List<T><string> tags

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI..
DateTime? expiresAt

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX..
bool? favourite

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering.
long? expiresIn

Number of milliseconds that inbox should exist for.
bool? allowTeamAccess

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization..
CreateInboxDto.InboxTypeEnum? inboxType

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send)..
bool? virtualInbox

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending..
bool? useShortAddress

Use a shorter email address under 31 characters.
string prefix

Prefix to add before the email address for easier labelling or identification..

Properties

View Source

AllowTeamAccess

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.

Declaration
[DataMember(Name = "allowTeamAccess", EmitDefaultValue = true)]
public bool? AllowTeamAccess { get; set; }
Property Value
Type Description
bool?

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
View Source

Description

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with

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

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
View Source

DomainId

ID of custom domain to use for email address.

Declaration
[DataMember(Name = "domainId", EmitDefaultValue = true)]
public Guid? DomainId { get; set; }
Property Value
Type Description
System.Guid?

ID of custom domain to use for email address.
View Source

DomainName

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the emailAddress option instead to specify the full custom inbox.

Declaration
[DataMember(Name = "domainName", EmitDefaultValue = true)]
public string DomainName { get; set; }
Property Value
Type Description
string

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the emailAddress option instead to specify the full custom inbox.
View Source

EmailAddress

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as 123@mailslurp.com. If you use the useDomainPool option when the email address is null it will generate an email address with a more varied domain ending such as 123@mailslurp.info or 123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so SMTP inboxes will only work with SMTP type domains. Avoid SMTP inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

Declaration
[DataMember(Name = "emailAddress", EmitDefaultValue = true)]
public string EmailAddress { get; set; }
Property Value
Type Description
string

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as 123@mailslurp.com. If you use the useDomainPool option when the email address is null it will generate an email address with a more varied domain ending such as 123@mailslurp.info or 123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so SMTP inboxes will only work with SMTP type domains. Avoid SMTP inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
View Source

ExpiresAt

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.

Declaration
[DataMember(Name = "expiresAt", EmitDefaultValue = true)]
public DateTime? ExpiresAt { get; set; }
Property Value
Type Description
DateTime?

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
View Source

ExpiresIn

Number of milliseconds that inbox should exist for

Declaration
[DataMember(Name = "expiresIn", EmitDefaultValue = true)]
public long? ExpiresIn { get; set; }
Property Value
Type Description
long?

Number of milliseconds that inbox should exist for
View Source

Favourite

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering

Declaration
[DataMember(Name = "favourite", EmitDefaultValue = true)]
public bool? Favourite { get; set; }
Property Value
Type Description
bool?

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
View Source

InboxType

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

Declaration
[DataMember(Name = "inboxType", EmitDefaultValue = true)]
public CreateInboxDto.InboxTypeEnum? InboxType { get; set; }
Property Value
Type Description
CreateInboxDto.InboxTypeEnum?

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
View Source

Name

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.

Declaration
[DataMember(Name = "name", EmitDefaultValue = true)]
public string Name { get; set; }
Property Value
Type Description
string

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
View Source

Prefix

Prefix to add before the email address for easier labelling or identification.

Declaration
[DataMember(Name = "prefix", EmitDefaultValue = true)]
public string Prefix { get; set; }
Property Value
Type Description
string

Prefix to add before the email address for easier labelling or identification.
View Source

Tags

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

Declaration
[DataMember(Name = "tags", EmitDefaultValue = true)]
public List<string> Tags { get; set; }
Property Value
Type Description
System.Collections.Generic.List<T><string>

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
View Source

UseDomainPool

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default @mailslurp.com email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in @mailslurp.{world,info,xyz,...} . This means a TLD is randomly selecting from a list of .biz, .info, .xyz etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of @mailslurp.com or custom email address provided by the emailAddress field. Note this feature is only available for HTTP inbox types.

Declaration
[DataMember(Name = "useDomainPool", EmitDefaultValue = true)]
public bool? UseDomainPool { get; set; }
Property Value
Type Description
bool?

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default @mailslurp.com email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in @mailslurp.{world,info,xyz,...} . This means a TLD is randomly selecting from a list of .biz, .info, .xyz etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of @mailslurp.com or custom email address provided by the emailAddress field. Note this feature is only available for HTTP inbox types.
View Source

UseShortAddress

Use a shorter email address under 31 characters

Declaration
[DataMember(Name = "useShortAddress", EmitDefaultValue = true)]
public bool? UseShortAddress { get; set; }
Property Value
Type Description
bool?

Use a shorter email address under 31 characters
View Source

VirtualInbox

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.

Declaration
[DataMember(Name = "virtualInbox", EmitDefaultValue = true)]
public bool? VirtualInbox { get; set; }
Property Value
Type Description
bool?

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.

Methods

View Source

Equals(CreateInboxDto)

Returns true if CreateInboxDto instances are equal

Declaration
public bool Equals(CreateInboxDto input)
Parameters
Type Name Description
CreateInboxDto input

Instance of CreateInboxDto 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
View Source

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
Type Description
int

Hash code
Overrides
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.ComponentModel.DataAnnotations.IValidatableObject