MessageSet Unicode C Reference Documentation

MessageSet

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

Create/Dispose

HCkMessageSetW CkMessageSetW_Create(void);

Creates an instance of the HCkMessageSetW object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkMessageSetW_Dispose(HCkMessageSetW handle);

Objects created by calling CkMessageSetW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkMessageSetW_Dispose.

Properties

int CkMessageSetW_getCount(HCkMessageSetW cHandle);

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

BOOL CkMessageSetW_getHasUids(HCkMessageSetW cHandle);

void CkMessageSetW_putHasUids(HCkMessageSetW cHandle, BOOL newVal);

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

Methods

BOOL CkMessageSetW_ContainsId(HCkMessageSetW cHandle, int msgId);

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

BOOL CkMessageSetW_FromCompactString(HCkMessageSetW cHandle, 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 CkMessageSetW_GetId(HCkMessageSetW cHandle, 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 CkMessageSetW_InsertId(HCkMessageSetW cHandle, int id);

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

BOOL CkMessageSetW_LoadTaskResult(HCkMessageSetW cHandle, HCkTaskW 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 CkMessageSetW_RemoveId(HCkMessageSetW cHandle, int id);

Removes a message ID from the set.

BOOL CkMessageSetW_ToCommaSeparatedStr(HCkMessageSetW cHandle, HCkString outStr);

const wchar_t *CkMessageSetW_toCommaSeparatedStr(HCkMessageSetW cHandle);

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

Returns TRUE for success, FALSE for failure.

BOOL CkMessageSetW_ToCompactString(HCkMessageSetW cHandle, HCkString outStr);

const wchar_t *CkMessageSetW_toCompactString(HCkMessageSetW cHandle);

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.