Mailboxes Xojo Plugin Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

Dim mailboxes As New Chilkat.Mailboxes

Properties

Count As Int32 (read-only)

The number of mailboxes in the collection.

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

Methods

Function GetFlags(index As Int32) As String

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

Returns Nil on failure

Function GetMailboxIndex(mbxName As String) As Int32

Returns the index of the mailbox having the specified name.

Function GetName(index As Int32) As String

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

Returns Nil on failure

Function GetNthFlag(index As Int32, flagIndex As Int32) 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 Nil on failure

Function GetNumFlags(index As Int32) As Int32

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

Function HasFlag(index As Int32, 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(index As Int32) 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(index As Int32) As Boolean

Returns True if the Nth mailbox is marked.

Function IsSelectable(index As Int32) As Boolean

Returns True if the Nth mailbox is selectable.

Function LoadTaskResult(task As Chilkat.Task) As Boolean

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns True for success, False for failure.