Mailboxes C Reference Documentation

Mailboxes

Current Version: 11.0.0

Requires Chilkat Bundle License

Represents a collection of IMAP mailboxes.

Create/Dispose

HCkMailboxes instance = CkMailboxes_Create();
// ...
CkMailboxes_Dispose(instance);

HCkMailboxes CkMailboxes_Create(void);

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

void CkMailboxes_Dispose(HCkMailboxes handle);

Objects created by calling CkMailboxes_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 CkMailboxes_Dispose.

Properties

Count

int CkMailboxes_getCount(HCkMailboxes cHandle);

The number of mailboxes in the collection.

Note: The Mailboxes class is for use with the Chilkat IMAP component.

DebugLogFilePath

void CkMailboxes_getDebugLogFilePath(HCkMailboxes cHandle, HCkString retval);
void CkMailboxes_putDebugLogFilePath(HCkMailboxes cHandle, const char *newVal);
const char *CkMailboxes_debugLogFilePath(HCkMailboxes 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.

LastErrorHtml

void CkMailboxes_getLastErrorHtml(HCkMailboxes cHandle, HCkString retval);
const char *CkMailboxes_lastErrorHtml(HCkMailboxes 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 CkMailboxes_getLastErrorText(HCkMailboxes cHandle, HCkString retval);
const char *CkMailboxes_lastErrorText(HCkMailboxes 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 CkMailboxes_getLastErrorXml(HCkMailboxes cHandle, HCkString retval);
const char *CkMailboxes_lastErrorXml(HCkMailboxes 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 CkMailboxes_getLastMethodSuccess(HCkMailboxes cHandle);
void CkMailboxes_putLastMethodSuccess(HCkMailboxes 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 CkMailboxes_getUtf8(HCkMailboxes cHandle);
void CkMailboxes_putUtf8(HCkMailboxes 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 CkMailboxes_getVerboseLogging(HCkMailboxes cHandle);
void CkMailboxes_putVerboseLogging(HCkMailboxes 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 CkMailboxes_getVersion(HCkMailboxes cHandle, HCkString retval);
const char *CkMailboxes_version(HCkMailboxes cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetFlags

BOOL CkMailboxes_GetFlags(HCkMailboxes cHandle, int index, HCkString outStr);
const char *CkMailboxes_getFlags(HCkMailboxes cHandle, int index);

Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".

Returns TRUE for success, FALSE for failure.

GetMailboxIndex

int CkMailboxes_GetMailboxIndex(HCkMailboxes cHandle, const char *mbxName);

Returns the index of the mailbox having the specified name.

GetName

BOOL CkMailboxes_GetName(HCkMailboxes cHandle, int index, HCkString outStrName);
const char *CkMailboxes_getName(HCkMailboxes cHandle, int index);

The name of the Nth mailbox in this collection. Indexing begins at 0.

Returns TRUE for success, FALSE for failure.

GetNthFlag

BOOL CkMailboxes_GetNthFlag(HCkMailboxes cHandle, int index, int flagIndex, HCkString outStr);
const char *CkMailboxes_getNthFlag(HCkMailboxes cHandle, int index, int flagIndex);

Returns the name of the Nth flag for the Mth mailbox. The index is the index of the mailbox. The flagIndex is the index of the flag.

Returns TRUE for success, FALSE for failure.

GetNumFlags

int CkMailboxes_GetNumFlags(HCkMailboxes cHandle, int index);

Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.

HasFlag

BOOL CkMailboxes_HasFlag(HCkMailboxes cHandle, int index, const char *flagName);

Returns TRUE if the Nth mailbox has the specified flag set. The flag name is case insensitive and should begin with a backslash character, such as "\Flagged". The index is the index of the Nth mailbox.

More Information and Examples

Find the "Sent" IMAP Mailbox

HasInferiors

BOOL CkMailboxes_HasInferiors(HCkMailboxes cHandle, int index);

Returns TRUE if the Nth mailbox has inferiors (i.e. sub-mailboxes), or if it is possible to create child mailboxes in the future.

Note: the HasNoChildren attribute/flag should not be confused with the IMAP4 [RFC-2060] defined attribute Noinferiors which indicates that no child mailboxes exist now AND none can be created in the future.

More Information and Examples

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

IsMarked

BOOL CkMailboxes_IsMarked(HCkMailboxes cHandle, int index);

Returns TRUE if the Nth mailbox is marked.

IsSelectable

BOOL CkMailboxes_IsSelectable(HCkMailboxes cHandle, int index);

Returns TRUE if the Nth mailbox is selectable.

LoadTaskResult

BOOL CkMailboxes_LoadTaskResult(HCkMailboxes cHandle, HCkTask task);

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.