Mailboxes DataFlex Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

Handle hoMailboxes
Get Create(RefClass(cComMailboxes)) to hoMailboxes

Properties

Function ComCount Returns Integer

The number of mailboxes in the collection.

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

Methods

Function ComGetFlags Integer index Returns String

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

Returns True for success, False for failure.

Function ComGetMailboxIndex String mbxName Returns Integer

Returns the index of the mailbox having the specified name.

Function ComGetName Integer index Returns String

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

Returns True for success, False for failure.

Function ComGetNthFlag Integer index Integer flagIndex Returns 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 True for success, False for failure.

Function ComGetNumFlags Integer index Returns Integer

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

Function ComHasFlag Integer index String flagName Returns 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 ComHasInferiors Integer index Returns 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 ComIsMarked Integer index Returns Boolean

Returns True if the Nth mailbox is marked.

Function ComIsSelectable Integer index Returns Boolean

Returns True if the Nth mailbox is selectable.

Function ComLoadTaskResult cComChilkatTask task Returns Boolean

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns True for success, False for failure.