Mailboxes Unicode C Reference Documentation
Mailboxes
Current Version: 10.0.0
Represents a collection of IMAP mailboxes.
Create/Dispose
HCkMailboxesW instance = CkMailboxesW_Create(); // ... CkMailboxesW_Dispose(instance);
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.
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
The number of mailboxes in the collection.
Note: The Mailboxes class is for use with the Chilkat IMAP component.
topLastMethodSuccess
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.
topMethods
GetFlags
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.
topGetMailboxIndex
Returns the index of the mailbox having the specified name.
topGetName
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.
topGetNthFlag
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.
topGetNumFlags
Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.
topHasFlag
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.
HasInferiors
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.
IsMarked
Returns TRUE if the Nth mailbox is marked.
topIsSelectable
Returns TRUE if the Nth mailbox is selectable.
topLoadTaskResult
Loads the mailboxes object from a completed asynchronous task.
Returns TRUE for success, FALSE for failure.
top