CkoMailboxes Objective-C Reference Documentation

CkoMailboxes

Current Version: 10.1.0
Requires Chilkat Bundle License

Represents a collection of IMAP mailboxes.

Object Creation

CkoMailboxes *obj = [[CkoMailboxes alloc] init];

Properties

Count
@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.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top

Methods

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

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

Returns nil on failure

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

Returns the index of the mailbox having the specified name.

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

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

Returns nil on failure

top
GetNthFlag
- (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

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

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

top
HasFlag
- (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.

More Information and Examples
Find the "Sent" IMAP Mailbox
top
HasInferiors
- (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.

More Information and Examples
HasInferiors always True? (Why HasInferiors is Often Misunderstood)
top
IsMarked
- (BOOL)IsMarked:(NSNumber *)index;

Returns YES if the Nth mailbox is marked.

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

Returns YES if the Nth mailbox is selectable.

top
LoadTaskResult
- (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.

top