CkoMessageSet Swift Reference Documentation

CkoMessageSet

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

Properties

Count: Int (read-only)

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

HasUids: Bool

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

Methods

ContainsId(msgId: Int) -> Bool

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

FromCompactString(str: String) -> Bool

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

GetId(index: Int) -> Int

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

InsertId(id: Int)

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

LoadTaskResult(task: CkoTask) -> Bool

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns true for success, false for failure.

RemoveId(id: Int)

Removes a message ID from the set.

ToCommaSeparatedStr() -> String

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

Returns true for success, false for failure.

ToCompactString() -> String

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 true for success, false for failure.