MessageSet PureBasic Reference Documentation

MessageSet

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

Object Creation

obj.i = CkMessageSet::ckCreate()

; Make sure to dispose of the object when finished like this:
CkMessageSet::ckDispose(obj);

Properties

Declare.i ckCount(obj.i) ; (read-only)

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

Declare.i ckHasUids(obj.i)
Declare setCkHasUids(obj.i, value.i)

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

Methods

Declare.i ckContainsId(obj.i, msgId.i)

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

Declare.i ckFromCompactString(obj.i, str.s)

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

Declare.i ckGetId(obj.i, index.i)

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

Declare ckInsertId(obj.i, id.i)

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

Declare.i ckLoadTaskResult(obj.i, task.i)

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns 1 for success, 0 for failure.

Declare ckRemoveId(obj.i, id.i)

Removes a message ID from the set.

Declare.s ckToCommaSeparatedStr(obj.i)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckToCompactString(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.