Class UpdateInboxOptions

Options for updating inbox properties

Inheritance

object

UpdateInboxOptions

Implements

IEquatable<UpdateInboxOptions>

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

Constructors

UpdateInboxOptions(string, string, List<string>, DateTime?, bool?)

Initializes a new instance of the UpdateInboxOptions class.

Declaration

public UpdateInboxOptions(string name = null, string description = null, List<string> tags = null, DateTime? expiresAt = null, bool? favourite = null)

Parameters

Type	Name	Description
string	name	Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search.
string	description	Description of an inbox for labelling and searching purposes.
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	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.

Properties

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

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.

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

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

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.

Methods

Equals(UpdateInboxOptions)

Returns true if UpdateInboxOptions instances are equal

Declaration

public bool Equals(UpdateInboxOptions input)

Parameters

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