Mailboxes Unicode C Reference Documentation

Mailboxes

Current Version: 9.5.0.73

Represents a collection of IMAP mailboxes.

Create/Dispose

HCkMailboxesW instance = CkMailboxesW_Create();
// ...
CkMailboxesW_Dispose(instance);
HCkMailboxesW CkMailboxesW_Create(void);

Creates an instance of the HCkMailboxesW object and returns a handle ("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

Count
int CkMailboxesW_getCount(HCkMailboxesW cHandle);

The number of mailboxes in the collection.

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

top
LastMethodSuccess
BOOL CkMailboxesW_getLastMethodSuccess(HCkMailboxesW cHandle);
void CkMailboxesW_putLastMethodSuccess(HCkMailboxesW 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

Methods

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

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

Returns the index of the mailbox having the specified name.

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

top
GetNthFlag
BOOL CkMailboxesW_GetNthFlag(HCkMailboxesW cHandle, int index, int flagIndex, const wchar_t *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.

top
GetNumFlags
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.

top
HasFlag
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.

top
HasInferiors
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.

top
IsMarked
BOOL CkMailboxesW_IsMarked(HCkMailboxesW cHandle, int index);

Returns TRUE if the Nth mailbox is marked.

top
IsSelectable
BOOL CkMailboxesW_IsSelectable(HCkMailboxesW cHandle, int index);

Returns TRUE if the Nth mailbox is selectable.

top
LoadTaskResult
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.

top