MessageSet C Reference Documentation

MessageSet

Current Version: 11.0.0

Requires Chilkat Bundle License

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.

DebugLogFilePath

void CkMessageSet_getDebugLogFilePath(HCkMessageSet cHandle, HCkString retval);
void CkMessageSet_putDebugLogFilePath(HCkMessageSet cHandle, const char *newVal);
const char *CkMessageSet_debugLogFilePath(HCkMessageSet cHandle);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

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.

LastErrorHtml

void CkMessageSet_getLastErrorHtml(HCkMessageSet cHandle, HCkString retval);
const char *CkMessageSet_lastErrorHtml(HCkMessageSet cHandle);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void CkMessageSet_getLastErrorText(HCkMessageSet cHandle, HCkString retval);
const char *CkMessageSet_lastErrorText(HCkMessageSet cHandle);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkMessageSet_getLastErrorXml(HCkMessageSet cHandle, HCkString retval);
const char *CkMessageSet_lastErrorXml(HCkMessageSet cHandle);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

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

Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

Utf8

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

When set to TRUE, all const char * arguments and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.

VerboseLogging

BOOL CkMessageSet_getVerboseLogging(HCkMessageSet cHandle);
void CkMessageSet_putVerboseLogging(HCkMessageSet cHandle, BOOL newVal);

If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

void CkMessageSet_getVersion(HCkMessageSet cHandle, HCkString retval);
const char *CkMessageSet_version(HCkMessageSet cHandle);

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

ContainsId

BOOL CkMessageSet_ContainsId(HCkMessageSet cHandle, unsigned long msgId);

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

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

GetId

unsigned long CkMessageSet_GetId(HCkMessageSet cHandle, int index);

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

More Information and Examples

How to Download Messages in MessageSet One at a Time

InsertId

void CkMessageSet_InsertId(HCkMessageSet cHandle, unsigned long id);

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

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.

RemoveId

void CkMessageSet_RemoveId(HCkMessageSet cHandle, unsigned long id);

Removes a message ID from the set.

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.

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.