Class InboxPreview

Inbox data preview element.

Inheritance

object

InboxPreview

Implements

IEquatable<InboxPreview>

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 = "InboxPreview")]
public class InboxPreview : IEquatable<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, string, FunctionsAsEnum?)

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, string expiresAt = null, InboxPreview.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?	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..
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.
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..
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).
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..
InboxPreview.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'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

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", 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 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
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 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

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.

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

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

Returns true if InboxPreview instances are equal

Declaration

public bool Equals(InboxPreview input)

Parameters

Type	Name	Description
InboxPreview	input	Instance of InboxPreview 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

Class InboxPreview

Inheritance

Implements

Inherited Members

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

Constructors

InboxPreview()

Declaration

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

Declaration

Parameters

Properties

CreatedAt

Declaration

Property Value

DomainId

Declaration

Property Value

EmailAddress

Declaration

Property Value

ExpiresAt

Declaration

Property Value

Favourite

Declaration

Property Value

FunctionsAs

Declaration

Property Value

Id

Declaration

Property Value

InboxType

Declaration

Property Value

Name

Declaration

Property Value

Tags

Declaration

Property Value

TeamAccess

Declaration

Property Value

VirtualInbox

Declaration

Property Value

Methods

Equals(InboxPreview)

Declaration

Parameters

Returns

Equals(object)

Declaration

Parameters

Returns

Overrides

GetHashCode()

Declaration

Returns

Overrides

ToJson()

Declaration

Returns

ToString()

Declaration

Returns

Overrides

Validate(ValidationContext)

Declaration

Parameters

Returns

Implements