CkMessageSetW Unicode C++ Reference Documentation

CkMessageSetW

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

Properties

int get_Count(void);

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

bool get_HasUids(void);
void put_HasUids(bool newVal);

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

Methods

bool ContainsId(int msgId);

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

bool FromCompactString(const wchar_t *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

int GetId(int 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(int id);

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

bool LoadTaskResult(CkTaskW &task);

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns true for success, false for failure.

void RemoveId(int id);

Removes a message ID from the set.

bool ToCommaSeparatedStr(CkString &outStr);
const wchar_t *toCommaSeparatedStr(void);

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

Returns true for success, false for failure.

bool ToCompactString(CkString &outStr);
const wchar_t *toCompactString(void);

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.