Class InboxDto

Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either SMTP or HTTP mailboxes. The default, HTTP inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. SMTP inboxes use a custom mail server at mxslurp.click and support SMTP login, IMAP and POP3. Use the EmailController or the InboxController methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching.

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

Constructors

View Source

InboxDto()

Initializes a new instance of the InboxDto class.

Declaration
[JsonConstructor]
protected InboxDto()
View Source

InboxDto(Guid, Guid?, DateTime, string, Guid?, string, string, string, bool, List<string>, InboxTypeEnum?, bool, bool, FunctionsAsEnum?)

Initializes a new instance of the InboxDto class.

Declaration
public InboxDto(Guid id = default, Guid? userId = null, DateTime createdAt = default, string name = null, Guid? domainId = null, string description = null, string emailAddress = null, string expiresAt = null, bool favourite = false, List<string> tags = null, InboxDto.InboxTypeEnum? inboxType = null, bool readOnly = false, bool virtualInbox = false, InboxDto.FunctionsAsEnum? functionsAs = null)
Parameters
Type Name Description
System.Guid id

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically. (required).
System.Guid? userId

ID of user that inbox belongs to.
DateTime createdAt

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd&apos;T&apos;HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00. (required).
string name

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search.
System.Guid? domainId

ID of custom domain used by the inbox if any.
string description

Description of an inbox for labelling and searching purposes.
string emailAddress

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (required).
string expiresAt

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email..
bool favourite

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering (required).
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..
InboxDto.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 readOnly

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes. (required).
bool virtualInbox

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. (required).
InboxDto.FunctionsAsEnum? functionsAs

Inbox function if used as a primitive for another system..

Properties

View Source

CreatedAt

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd&apos;T&apos;HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.

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

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd&apos;T&apos;HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.
View Source

Description

Description of an inbox for labelling and searching purposes

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

Description of an inbox for labelling and searching purposes
View Source

DomainId

ID of custom domain used by the inbox if any

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

ID of custom domain used by the inbox if any
View Source

EmailAddress

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

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

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
View Source

ExpiresAt

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

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

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
View Source

Favourite

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

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

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

FunctionsAs

Inbox function if used as a primitive for another system.

Declaration
[DataMember(Name = "functionsAs", EmitDefaultValue = true)]
public InboxDto.FunctionsAsEnum? FunctionsAs { get; set; }
Property Value
Type Description
InboxDto.FunctionsAsEnum?

Inbox function if used as a primitive for another system.
View Source

Id

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.

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

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.
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 InboxDto.InboxTypeEnum? InboxType { get; set; }
Property Value
Type Description
InboxDto.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

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

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

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

ReadOnly

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.

Declaration
[DataMember(Name = "readOnly", IsRequired = true, EmitDefaultValue = true)]
public bool ReadOnly { get; set; }
Property Value
Type Description
bool

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
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

UserId

ID of user that inbox belongs to

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

ID of user that inbox belongs to
View Source

VirtualInbox

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.

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

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.

Methods

View Source

Equals(InboxDto)

Returns true if InboxDto instances are equal

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

Instance of InboxDto 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