Mailboxes C Library Reference

Mailboxes

Represents a collection of IMAP mailboxes.

Create/Dispose

HCkMailboxes CkMailboxes_Create(void);

Creates an instance of the CkMailboxes 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 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.

C "Properties"

long CkMailboxes_getCount(HCkMailboxes handle);

The number of mailboxes in the collection.

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

BOOL CkMailboxes_getUtf8(HCkMailboxes handle);
void CkMailboxes_putUtf8(HCkMailboxes handle, BOOL newVal);

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

C "Methods"

BOOL CkMailboxes_GetName(HCkMailboxes handle, long index, HCkString strName);

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

BOOL CkMailboxes_HasInferiors(HCkMailboxes handle, long index);

Returns true if the Nth mailbox has inferiors (i.e. sub-mailboxes)

BOOL CkMailboxes_IsMarked(HCkMailboxes handle, long index);

Returns true if the Nth mailbox is marked.

BOOL CkMailboxes_IsSelectable(HCkMailboxes handle, long index);

Returns true if the Nth mailbox is selectable.

const char *CkMailboxes_getName(HCkMailboxes handle, long index);

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