CkMessageSet C++ Class Reference (Visual C++)

CkMessageSet

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

Properties

long get_Count(void);

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

bool get_HasUids(void) const;
void put_HasUids(bool value);

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

Methods

bool ContainsId(long msgId);

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

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

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

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

void RemoveId(long id);

Removes a message ID from the set.

void ToCompactString(CkString & str);

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

void ToString(CkString & str);

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

const char * 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

const char * toString();

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