CkoMessageSet Objective-C Reference Documentation

CkoMessageSet

Represents a collection of email message sequence numbers or UIDs on an IMAP server.

Properties

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

The number of message UIDs (or sequence numbers) in this message set.

@property (nonatomic) BOOL HasUids;

If YES then the message set contains UIDs, otherwise it contains sequence numbers.

Methods

- (BOOL)ContainsId:(NSNumber *)id;

Returns YES if the msgId is contained in the message set.

- (BOOL)FromCompactString:(NSString *)str;

Loads the message set from a compact-string representation. Here are some examples:

Non-Compact String

Compact String

1,2,3,4,5

1:5

1,2,3,4,5,8,9,10

1:5,8:10

1,3,4,5,8,9,10

1,3:5,8:10

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

Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns -1 if the index is out of range.

- (void)InsertId:(NSNumber *)id;

Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.

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

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns YES for success, NO for failure.

- (void)RemoveId:(NSNumber *)id;

Removes a message ID from the set.

- (NSString *)ToCommaSeparatedStr;

Returns a string of comma-separated message IDs. (This is the non-compact string format.)

Returns nil on failure

- (NSString *)ToCompactString;

Returns the set of message IDs represented as a compact string. Here are some examples:

Non-Compact String

Compact String

1,2,3,4,5

1:5

1,2,3,4,5,8,9,10

1:5,8:10

1,3,4,5,8,9,10

1,3:5,8:10

Returns nil on failure