CkoMessageSet Objective-C Reference Documentation

CkoMessageSet

Current Version: 9.5.0.75

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

Object Creation

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

Properties

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

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

top
HasUids
@property (nonatomic) BOOL HasUids;

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

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

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

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

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

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

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

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

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

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

Removes a message ID from the set.

top
ToCommaSeparatedStr
- (NSString *)ToCommaSeparatedStr;

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

Returns nil on failure

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

top