Mailboxes PureBasic Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Object Creation

obj.i = CkMailboxes::ckCreate()

; Make sure to dispose of the object when finished like this:
CkMailboxes::ckDispose(obj);

Properties

Declare.i ckCount(obj.i) ; (read-only)

The number of mailboxes in the collection.

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

Methods

Declare.s ckGetFlags(obj.i, index.i)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckGetMailboxIndex(obj.i, mbxName.s)

Returns the index of the mailbox having the specified name.

Declare.s ckGetName(obj.i, index.i)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckGetNthFlag(obj.i, index.i, flagIndex.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckGetNumFlags(obj.i, index.i)

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

Declare.i ckHasFlag(obj.i, index.i, flagName.s)

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

Declare.i ckHasInferiors(obj.i, index.i)

Returns 1 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)

Declare.i ckIsMarked(obj.i, index.i)

Returns 1 if the Nth mailbox is marked.

Declare.i ckIsSelectable(obj.i, index.i)

Returns 1 if the Nth mailbox is selectable.

Declare.i ckLoadTaskResult(obj.i, task.i)

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.