CkoMailboxes Swift Reference Documentation

CkoMailboxes

Represents a collection of IMAP mailboxes.

Properties

Count: Int (read-only)

The number of mailboxes in the collection.

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

Methods

GetFlags(index: Int) -> String

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

Returns true for success, false for failure.

GetMailboxIndex(mbxName: String) -> Int

Returns the index of the mailbox having the specified name.

GetName(index: Int) -> String

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

Returns true for success, false for failure.

GetNthFlag(index: Int, flagIndex: Int) -> 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.

GetNumFlags(index: Int) -> Int

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

HasFlag(index: Int, flagName: String) -> Bool

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.

HasInferiors(index: Int) -> Bool

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)

IsMarked(index: Int) -> Bool

Returns true if the Nth mailbox is marked.

IsSelectable(index: Int) -> Bool

Returns true if the Nth mailbox is selectable.

LoadTaskResult(task: CkoTask) -> Bool

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns true for success, false for failure.