ImapFolderStatus Class

Namespace:
GemBox.Email.Imap
Assembly:
GemBox.Email.dll

Represents an IMAP folder status.

public sealed class ImapFolderStatus
Public NotInheritable Class ImapFolderStatus
Inheritance:
System.Object
ImapFolderStatus

Properties

Count

Gets mail message count for the folder.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

Then number of mail messages.

Flags

Gets the defined folder flags.

public ReadOnlyCollection<string> Flags { get; }
Public ReadOnly Property Flags As ReadOnlyCollection(Of String)
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<System.String>

A read-only collection of defined folder flags.

IsReadOnly

Gets a value indicating whether folder is read only.

public bool IsReadOnly { get; }
Public ReadOnly Property IsReadOnly As Boolean
Property Value
System.Boolean

True if this instance is read only; otherwise, false.

Name

Gets the folder name.

public string Name { get; }
Public ReadOnly Property Name As String
Property Value
System.String

System.String value representing folder name.

PermanentFlags

Gets the permanent folder flags.

public ReadOnlyCollection<string> PermanentFlags { get; }
Public ReadOnly Property PermanentFlags As ReadOnlyCollection(Of String)
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<System.String>

A read-only collection of permanent folder flags.

Remarks

A list of message flags that the client can change permanently, not only for current session. If collection is empty, all flags can be changed permanently.

Recent

Gets the number of mail messages with \Recent flag set.

public int Recent { get; }
Public ReadOnly Property Recent As Integer
Property Value
System.Int32

The number of recent mail messages.

UidNext

Gets the next unique identifier value.

public string UidNext { get; }
Public ReadOnly Property UidNext As String
Property Value
System.String

The next unique identifier value.

Remarks

Represents unique value that can be used for detecting folder changes. More detail can be found in RFC 3501 - section 2.3.1.1.

UidValidity

Gets the unique identifier validity value.

public string UidValidity { get; }
Public ReadOnly Property UidValidity As String
Property Value
System.String

The unique identifier validity value.

Remarks

Represents unique value that can be used for detecting folder changes. More detail can be found in RFC 3501 - section 2.3.1.1. If this value is null, mail server doesn't support UID commands.

Unseen

Gets the message number of first unseen mail message in the folder.

public int? Unseen { get; }
Public ReadOnly Property Unseen As Integer?
Property Value
System.Nullable<System.Int32>

The message number of first unseen mail message.

Remarks

Property is nullable because some mail servers don't provide or support it.