Mailboxes Unicode C Reference Documentation

Mailboxes

Represents a collection of IMAP mailboxes.

Create/Dispose

HCkMailboxesW CkMailboxesW_Create(void);

Creates an instance of the HCkMailboxesW 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 CkMailboxesW_Dispose(HCkMailboxesW handle);

Objects created by calling CkMailboxesW_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 CkMailboxesW_Dispose.

Properties

int CkMailboxesW_getCount(HCkMailboxesW cHandle);

The number of mailboxes in the collection.

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

Methods

BOOL CkMailboxesW_GetFlags(HCkMailboxesW cHandle, int index, HCkString outStr);

const wchar_t *CkMailboxesW_getFlags(HCkMailboxesW 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.

int CkMailboxesW_GetMailboxIndex(HCkMailboxesW cHandle, const wchar_t *mbxName);

Returns the index of the mailbox having the specified name.

BOOL CkMailboxesW_GetName(HCkMailboxesW cHandle, int index, HCkString outStrName);

const wchar_t *CkMailboxesW_getName(HCkMailboxesW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkMailboxesW_GetNthFlag(HCkMailboxesW cHandle, int index, int flagIndex, HCkString outStr);

const wchar_t *CkMailboxesW_getNthFlag(HCkMailboxesW 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.

int CkMailboxesW_GetNumFlags(HCkMailboxesW cHandle, int index);

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

BOOL CkMailboxesW_HasFlag(HCkMailboxesW cHandle, int index, const wchar_t *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.

BOOL CkMailboxesW_HasInferiors(HCkMailboxesW 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.

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

BOOL CkMailboxesW_IsMarked(HCkMailboxesW cHandle, int index);

Returns TRUE if the Nth mailbox is marked.

BOOL CkMailboxesW_IsSelectable(HCkMailboxesW cHandle, int index);

Returns TRUE if the Nth mailbox is selectable.

BOOL CkMailboxesW_LoadTaskResult(HCkMailboxesW cHandle, HCkTaskW task);

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.