MessageSet C Reference Documentation

MessageSet

Current Version: 9.5.0.73

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

Create/Dispose

HCkMessageSet instance = CkMessageSet_Create();
// ...
CkMessageSet_Dispose(instance);
HCkMessageSet CkMessageSet_Create(void);

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

void CkMessageSet_Dispose(HCkMessageSet handle);

Objects created by calling CkMessageSet_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 CkMessageSet_Dispose.

Properties

Count
int CkMessageSet_getCount(HCkMessageSet cHandle);

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

top
HasUids
BOOL CkMessageSet_getHasUids(HCkMessageSet cHandle);
void CkMessageSet_putHasUids(HCkMessageSet cHandle, BOOL newVal);

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

top
LastMethodSuccess
BOOL CkMessageSet_getLastMethodSuccess(HCkMessageSet cHandle);
void CkMessageSet_putLastMethodSuccess(HCkMessageSet cHandle, BOOL newVal);

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Utf8
BOOL CkMessageSet_getUtf8(HCkMessageSet cHandle);
void CkMessageSet_putUtf8(HCkMessageSet cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top

Methods

ContainsId
BOOL CkMessageSet_ContainsId(HCkMessageSet cHandle, int msgId);

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

top
FromCompactString
BOOL CkMessageSet_FromCompactString(HCkMessageSet cHandle, 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

top
GetId
int CkMessageSet_GetId(HCkMessageSet 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.

top
InsertId
void CkMessageSet_InsertId(HCkMessageSet cHandle, int id);

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

top
LoadTaskResult
BOOL CkMessageSet_LoadTaskResult(HCkMessageSet cHandle, HCkTask task);
Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.

top
RemoveId
void CkMessageSet_RemoveId(HCkMessageSet cHandle, int id);

Removes a message ID from the set.

top
ToCommaSeparatedStr
BOOL CkMessageSet_ToCommaSeparatedStr(HCkMessageSet cHandle, HCkString outStr);
const char *CkMessageSet_toCommaSeparatedStr(HCkMessageSet cHandle);

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

Returns TRUE for success, FALSE for failure.

top
ToCompactString
BOOL CkMessageSet_ToCompactString(HCkMessageSet cHandle, HCkString outStr);
const char *CkMessageSet_toCompactString(HCkMessageSet 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.

top