Class SearchInboxesOptions

SearchInboxesOptions

Inheritance

object

SearchInboxesOptions

Implements

IEquatable<SearchInboxesOptions>

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

Constructors

SearchInboxesOptions(int?, int?, SortDirectionEnum?, bool?, string, string, DateTime?, DateTime?, InboxTypeEnum?, InboxFunctionEnum?, Guid?)

Initializes a new instance of the SearchInboxesOptions class.

Declaration

public SearchInboxesOptions(int? pageIndex = null, int? pageSize = null, SearchInboxesOptions.SortDirectionEnum? sortDirection = null, bool? favourite = null, string search = null, string tag = null, DateTime? since = null, DateTime? before = null, SearchInboxesOptions.InboxTypeEnum? inboxType = null, SearchInboxesOptions.InboxFunctionEnum? inboxFunction = null, Guid? domainId = null)

Parameters

Type	Name	Description
int?	pageIndex	Optional page index in list pagination.
int?	pageSize	Optional page size in list pagination.
SearchInboxesOptions.SortDirectionEnum?	sortDirection	Optional createdAt sort direction ASC or DESC.
bool?	favourite	Optionally filter results for favourites only.
string	search	Optionally filter by search words partial matching ID, tags, name, and email address.
string	tag	Optionally filter by tags. Will return inboxes that include given tags.
DateTime?	since	Optional filter by created after given date time.
DateTime?	before	Optional filter by created before given date time.
SearchInboxesOptions.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)..
SearchInboxesOptions.InboxFunctionEnum?	inboxFunction	Optional filter by inbox function.
System.Guid?	domainId	Optional domain ID filter.

Properties

Before

Optional filter by created before given date time

Declaration

[DataMember(Name = "before", EmitDefaultValue = true)]
public DateTime? Before { get; set; }

Property Value

Type	Description
DateTime?	Optional filter by created before given date time

DomainId

Optional domain ID filter

Declaration

[DataMember(Name = "domainId", EmitDefaultValue = true)]
public Guid? DomainId { get; set; }

Property Value

Type	Description
System.Guid?	Optional domain ID filter

Favourite

Optionally filter results for favourites only

Declaration

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

Property Value

Type	Description
bool?	Optionally filter results for favourites only

InboxFunction

Optional filter by inbox function

Declaration

[DataMember(Name = "inboxFunction", EmitDefaultValue = true)]
public SearchInboxesOptions.InboxFunctionEnum? InboxFunction { get; set; }

Property Value

Type	Description
SearchInboxesOptions.InboxFunctionEnum?	Optional filter by inbox function

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 SearchInboxesOptions.InboxTypeEnum? InboxType { get; set; }

Property Value

Type	Description
SearchInboxesOptions.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).

PageIndex

Optional page index in list pagination

Declaration

[DataMember(Name = "pageIndex", EmitDefaultValue = true)]
public int? PageIndex { get; set; }

Property Value

Type	Description
int?	Optional page index in list pagination

PageSize

Optional page size in list pagination

Declaration

[DataMember(Name = "pageSize", EmitDefaultValue = true)]
public int? PageSize { get; set; }

Property Value

Type	Description
int?	Optional page size in list pagination

Search

Optionally filter by search words partial matching ID, tags, name, and email address

Declaration

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

Property Value

Type	Description
string	Optionally filter by search words partial matching ID, tags, name, and email address

Since

Optional filter by created after given date time

Declaration

[DataMember(Name = "since", EmitDefaultValue = true)]
public DateTime? Since { get; set; }

Property Value

Type	Description
DateTime?	Optional filter by created after given date time

SortDirection

Optional createdAt sort direction ASC or DESC

Declaration

[DataMember(Name = "sortDirection", EmitDefaultValue = true)]
public SearchInboxesOptions.SortDirectionEnum? SortDirection { get; set; }

Property Value

Type	Description
SearchInboxesOptions.SortDirectionEnum?	Optional createdAt sort direction ASC or DESC

Tag

Optionally filter by tags. Will return inboxes that include given tags

Declaration

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

Property Value

Type	Description
string	Optionally filter by tags. Will return inboxes that include given tags

Methods

Equals(SearchInboxesOptions)

Returns true if SearchInboxesOptions instances are equal

Declaration

public bool Equals(SearchInboxesOptions input)

Parameters

Type	Name	Description
SearchInboxesOptions	input	Instance of SearchInboxesOptions to be compared

Returns

Type	Description
bool	Boolean

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)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

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

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