Class InboxPreview

Inbox data preview element.

Inheritance
object
InboxPreview
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "InboxPreview")]
public class InboxPreview : IValidatableObject

Constructors

View Source

InboxPreview()

Initializes a new instance of the InboxPreview class.

Declaration
[JsonConstructor]
protected InboxPreview()
View Source

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

Initializes a new instance of the InboxPreview class.

Declaration
public InboxPreview(Guid id = default, Guid? domainId = null, string emailAddress = null, DateTime createdAt = default, bool favourite = false, string name = null, List<string> tags = null, bool teamAccess = false, InboxPreview.InboxTypeEnum? inboxType = null, bool virtualInbox = false, DateTime? expiresAt = null, InboxPreview.FunctionsAsEnum? functionsAs = null, Guid? userId = null, string description = null, InboxPreview.AccountRegionEnum? accountRegion = null)
Parameters
Type Name Description
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).
Guid? domainId

ID of custom domain used by the inbox if any.
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).
DateTime createdAt

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00. (required).
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).
string name

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search.
List<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..
bool teamAccess

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/ (required).
InboxPreview.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 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).
DateTime? 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..
InboxPreview.FunctionsAsEnum? functionsAs

Inbox function if used as a primitive for another system..
Guid? userId

ID of user that inbox belongs to (required).
string description

Description of an inbox for labelling and searching purposes.
InboxPreview.AccountRegionEnum? accountRegion

Region of the inbox.

Properties

View Source

AccountRegion

Region of the inbox

Declaration
[DataMember(Name = "accountRegion", EmitDefaultValue = true)]
public InboxPreview.AccountRegionEnum? AccountRegion { get; set; }
Property Value
Type Description
InboxPreview.AccountRegionEnum?

Region of the inbox
View Source

CreatedAt

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'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'T'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
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 DateTime? ExpiresAt { get; set; }
Property Value
Type Description
DateTime?

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 InboxPreview.FunctionsAsEnum? FunctionsAs { get; set; }
Property Value
Type Description
InboxPreview.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
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 InboxPreview.InboxTypeEnum? InboxType { get; set; }
Property Value
Type Description
InboxPreview.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

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
List<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

TeamAccess

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/

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

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
View Source

UserId

ID of user that inbox belongs to

Declaration
[DataMember(Name = "userId", IsRequired = true, EmitDefaultValue = true)]
public Guid? UserId { get; set; }
Property Value
Type Description
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

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

Implements