Mailboxes VB.NET WinRT Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

Dim obj As New Chilkat.Mailboxes()

Properties

Count As Integer (ReadOnly)

The number of mailboxes in the collection.

Note: The Mailboxes class is for use with the Chilkat IMAP component.

Methods

Function GetFlags(ByVal index As Integer) As String

Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".

Returns Nothing on failure

Function GetMailboxIndex(ByVal mbxName As String) As Integer

Returns the index of the mailbox having the specified name.

Function GetName(ByVal index As Integer) As String

The name of the Nth mailbox in this collection. Indexing begins at 0.

Returns Nothing on failure

Function GetNthFlag(ByVal index As Integer, ByVal flagIndex As Integer) As String

Returns the name of the Nth flag for the Mth mailbox. The index is the index of the mailbox. The flagIndex is the index of the flag.

Returns Nothing on failure

Function GetNumFlags(ByVal index As Integer) As Integer

Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.

Function HasFlag(ByVal index As Integer, ByVal flagName As String) As Boolean

Returns True if the Nth mailbox has the specified flag set. The flag name is case insensitive and should begin with a backslash character, such as "\Flagged". The index is the index of the Nth mailbox.

Function HasInferiors(ByVal index As Integer) As Boolean

Returns True if the Nth mailbox has inferiors (i.e. sub-mailboxes), or if it is possible to create child mailboxes in the future.

Note: the HasNoChildren attribute/flag should not be confused with the IMAP4 [RFC-2060] defined attribute Noinferiors which indicates that no child mailboxes exist now AND none can be created in the future.

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

Function IsMarked(ByVal index As Integer) As Boolean

Returns True if the Nth mailbox is marked.

Function IsSelectable(ByVal index As Integer) As Boolean

Returns True if the Nth mailbox is selectable.