CkoMailboxes Objective-C Reference Documentation

CkoMailboxes

Represents a collection of IMAP mailboxes.

Properties

@property (nonatomic, readonly, copy) NSNumber *Count;

The number of mailboxes in the collection.

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

Methods

- (NSString *)GetFlags:(NSNumber *)index;

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

Returns nil on failure

- (NSNumber *)GetMailboxIndex:(NSString *)mbxName;

Returns the index of the mailbox having the specified name.

- (NSString *)GetName:(NSNumber *)index;

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

Returns nil on failure

- (NSString *)GetNthFlag:(NSNumber *)index
    flagIndex:(NSNumber *)flagIndex;

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

- (NSNumber *)GetNumFlags:(NSNumber *)index;

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

- (BOOL)HasFlag:(NSNumber *)index
    flagName:(NSString *)flagName;

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

- (BOOL)HasInferiors:(NSNumber *)index;

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

- (BOOL)IsMarked:(NSNumber *)index;

Returns YES if the Nth mailbox is marked.

- (BOOL)IsSelectable:(NSNumber *)index;

Returns YES if the Nth mailbox is selectable.

- (BOOL)LoadTaskResult:(CkoTask *)task;

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns YES for success, NO for failure.