Mailboxes Lianja Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

loObject = createobject("CkMailboxes")

Properties

Count As Numeric (read-only)

The number of mailboxes in the collection.

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

Methods

GetFlags(index As Numeric) As Character

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

Returns .T. for success, .F. for failure.

GetMailboxIndex(mbxName As Character) As Numeric

Returns the index of the mailbox having the specified name.

GetName(index As Numeric) As Character

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

Returns .T. for success, .F. for failure.

GetNthFlag(index As Numeric, flagIndex As Numeric) As Character

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 .T. for success, .F. for failure.

GetNumFlags(index As Numeric) As Numeric

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

HasFlag(index As Numeric, flagName As Character) As Boolean

Returns .T. 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.

HasInferiors(index As Numeric) As Boolean

Returns .T. 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)

IsMarked(index As Numeric) As Boolean

Returns .T. if the Nth mailbox is marked.

IsSelectable(index As Numeric) As Boolean

Returns .T. if the Nth mailbox is selectable.

LoadTaskResult(task As CkTask) As Boolean

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns .T. for success, .F. for failure.