Class ImapMailboxStatus
ImapMailboxStatus
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "ImapMailboxStatus")]
public class ImapMailboxStatus : IEquatable<ImapMailboxStatus>, IValidatableObject
Constructors
View SourceImapMailboxStatus()
Initializes a new instance of the ImapMailboxStatus class.
Declaration
[JsonConstructor]
protected ImapMailboxStatus()
ImapMailboxStatus(string, bool, object, List<string>, List<string>, long, int, int, int, long, int, int?)
Initializes a new instance of the ImapMailboxStatus class.
Declaration
public ImapMailboxStatus(string name = null, bool readOnly = false, object items = null, List<string> flags = null, List<string> permanentFlags = null, long unseenSeqNum = 0, int messages = 0, int recent = 0, int unseen = 0, long uidNext = 0, int uidValidity = 0, int? appendLimit = null)
Parameters
Type | Name | Description |
---|---|---|
string | name | The mailbox name. (required). |
bool | readOnly | True if the mailbox is open in read-only mode. (required). |
object | items | Results map (required). |
System.Collections.Generic.List<T><string> | flags | The mailbox flags. (required). |
System.Collections.Generic.List<T><string> | permanentFlags | The mailbox permanent flags. (required). |
long | unseenSeqNum | The sequence number of the first unseen message in the mailbox. (required). |
int | messages | The number of messages in this mailbox. (required). |
int | recent | The number of messages not seen since the last time the mailbox was opened. (required). |
int | unseen | The number of unread messages. (required). |
long | uidNext | The next UID. (required). |
int | uidValidity | Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1. (required). |
int? | appendLimit | Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension. |
Properties
View SourceAppendLimit
Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension
Declaration
[DataMember(Name = "appendLimit", EmitDefaultValue = true)]
public int? AppendLimit { get; set; }
Property Value
Type | Description |
---|---|
int? | Per-mailbox limit of message size. Set only if server supports the APPENDLIMIT extension |
Flags
The mailbox flags.
Declaration
[DataMember(Name = "flags", IsRequired = true, EmitDefaultValue = true)]
public List<string> Flags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | The mailbox flags. |
Items
Results map
Declaration
[DataMember(Name = "items", IsRequired = true, EmitDefaultValue = true)]
public object Items { get; set; }
Property Value
Type | Description |
---|---|
object | Results map |
Messages
The number of messages in this mailbox.
Declaration
[DataMember(Name = "messages", IsRequired = true, EmitDefaultValue = true)]
public int Messages { get; set; }
Property Value
Type | Description |
---|---|
int | The number of messages in this mailbox. |
Name
The mailbox name.
Declaration
[DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | The mailbox name. |
PermanentFlags
The mailbox permanent flags.
Declaration
[DataMember(Name = "permanentFlags", IsRequired = true, EmitDefaultValue = true)]
public List<string> PermanentFlags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | The mailbox permanent flags. |
ReadOnly
True if the mailbox is open in read-only mode.
Declaration
[DataMember(Name = "readOnly", IsRequired = true, EmitDefaultValue = true)]
public bool ReadOnly { get; set; }
Property Value
Type | Description |
---|---|
bool | True if the mailbox is open in read-only mode. |
Recent
The number of messages not seen since the last time the mailbox was opened.
Declaration
[DataMember(Name = "recent", IsRequired = true, EmitDefaultValue = true)]
public int Recent { get; set; }
Property Value
Type | Description |
---|---|
int | The number of messages not seen since the last time the mailbox was opened. |
UidNext
The next UID.
Declaration
[DataMember(Name = "uidNext", IsRequired = true, EmitDefaultValue = true)]
public long UidNext { get; set; }
Property Value
Type | Description |
---|---|
long | The next UID. |
UidValidity
Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1.
Declaration
[DataMember(Name = "uidValidity", IsRequired = true, EmitDefaultValue = true)]
public int UidValidity { get; set; }
Property Value
Type | Description |
---|---|
int | Together with a UID, it is a unique identifier for a message. Must be greater than or equal to 1. |
Unseen
The number of unread messages.
Declaration
[DataMember(Name = "unseen", IsRequired = true, EmitDefaultValue = true)]
public int Unseen { get; set; }
Property Value
Type | Description |
---|---|
int | The number of unread messages. |
UnseenSeqNum
The sequence number of the first unseen message in the mailbox.
Declaration
[DataMember(Name = "unseenSeqNum", IsRequired = true, EmitDefaultValue = true)]
public long UnseenSeqNum { get; set; }
Property Value
Type | Description |
---|---|
long | The sequence number of the first unseen message in the mailbox. |
Methods
View SourceEquals(ImapMailboxStatus)
Returns true if ImapMailboxStatus instances are equal
Declaration
public bool Equals(ImapMailboxStatus input)
Parameters
Type | Name | Description |
---|---|---|
ImapMailboxStatus | input | Instance of ImapMailboxStatus 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
View SourceGetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | Hash code |
Overrides
View SourceToJson()
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
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 |