Mailboxes C Reference Documentation

Mailboxes

Current Version: 9.5.0.75

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.

top
LastMethodSuccess
BOOL CkMailboxes_getLastMethodSuccess(HCkMailboxes cHandle);
void CkMailboxes_putLastMethodSuccess(HCkMailboxes 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
Utf8
BOOL CkMailboxes_getUtf8(HCkMailboxes cHandle);
void CkMailboxes_putUtf8(HCkMailboxes cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top

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.

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

Returns the index of the mailbox having the specified name.

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

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

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

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

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

top
IsMarked
BOOL CkMailboxes_IsMarked(HCkMailboxes cHandle, int index);

Returns TRUE if the Nth mailbox is marked.

top
IsSelectable
BOOL CkMailboxes_IsSelectable(HCkMailboxes cHandle, int index);

Returns TRUE if the Nth mailbox is selectable.

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

top