Mailboxes C++ Reference Documentation

CkMailboxes

Current Version: 11.5.0

Requires Chilkat Bundle License

Chilkat.Mailboxes

Inspect IMAP mailbox names and attributes returned by Chilkat.Imap.

Chilkat.Mailboxes is a read-only result collection populated by Chilkat.Imap.MbxList. Applications inspect the returned mailbox names and attributes but do not directly add, remove, or modify entries. The class provides indexed access to mailbox flags, selectable status, marked status, whether child mailboxes exist, and whether child mailboxes may be created.

Mailbox collection

Receive the read-only list of IMAP mailboxes populated by Chilkat.Imap.MbxList.

Indexed mailbox access

Use the mailbox count and index-based methods to retrieve each mailbox name in the returned collection.

Mailbox flags

Inspect IMAP flags associated with each mailbox, including standard and server-specific attributes.

Selectable status

Determine whether a mailbox can be selected and opened for message access.

Hierarchy information

Check whether a mailbox has child mailboxes or whether children may be created beneath it.

Marked status

Detect whether a mailbox is marked or unmarked according to the attributes returned by the IMAP server.

Common pattern: Call Chilkat.Imap.MbxList to populate a Mailboxes object, loop from 0 to Count - 1, retrieve each mailbox name, and inspect its flags or selectable status. Mailbox names are exposed as normal Unicode text; Chilkat automatically handles modified UTF-7 or IMAP UTF-8 at the protocol level.

For an extended overview, see Mailboxes Class Overview.

Object Creation

// Local variable on the stack
CkMailboxes obj;

// Dynamically allocate/delete
CkMailboxes *pObj = new CkMailboxes();
// ...
delete pObj;

Properties

Count

int get_Count(void);

Returns the number of mailboxes in this collection. An empty collection has a count of 0.

Mailboxes is a read-only result container populated by Imap.MbxList. Applications inspect the returned entries but do not directly add, remove, or modify mailboxes in this object.

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *newVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Utf8

bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

void get_Version(CkString &str);
const char *version(void);

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetFlags

bool GetFlags(int index, CkString &outStr);
const char *getFlags(int index);

Returns a comma-separated list of flags for the mailbox at the zero-based index specified by index.

For example:

\HasNoChildren,\Important

To inspect the flags individually, use GetNumFlags and GetNthFlag.

Returns true for success, false for failure.

More Information and Examples

List and Inspect IMAP Mailboxes

GetMailboxIndex

int GetMailboxIndex(const char *mbxName);

Returns the zero-based index of the mailbox whose name matches mbxName.

Pass mbxName as a normal Unicode mailbox name. Chilkat automatically handles the protocol-level modified UTF-7 or IMAP UTF-8 representation; the application should not encode the mailbox name manually.

The returned index can be used with methods such as GetName, GetFlags, and IsSelectable.

More Information and Examples

List and Inspect IMAP Mailboxes

GetName

bool GetName(int index, CkString &outStrName);
const char *getName(int index);

Returns the name of the mailbox at the zero-based index specified by index.

The name is returned as normal Unicode text. Chilkat automatically decodes modified UTF-7 or IMAP UTF-8 mailbox names received from the server and automatically performs the corresponding encoding when the name is passed to an Imap method.

The returned name can therefore be passed directly to methods that select, examine, create, rename, delete, copy to, or otherwise operate on a mailbox. Do not manually encode or decode the mailbox name.

Returns true for success, false for failure.

More Information and Examples

List and Inspect IMAP Mailboxes

GetNthFlag

bool GetNthFlag(int index, int flagIndex, CkString &outStr);
const char *getNthFlag(int index, int flagIndex);

Returns one flag from a mailbox in the collection.

index is the zero-based mailbox index.
flagIndex is the zero-based flag index within that mailbox.

Call GetNumFlags to determine the number of flags available for the mailbox.

Returns true for success, false for failure.

More Information and Examples

List and Inspect IMAP Mailboxes

GetNumFlags

int GetNumFlags(int index);

Returns the number of flags associated with the mailbox at the zero-based index specified by index.

Returns -1 if index is outside the valid mailbox-index range. Use GetNthFlag to retrieve the individual flags.

More Information and Examples

List and Inspect IMAP Mailboxes

HasFlag

bool HasFlag(int index, const char *flagName);

Returns true if the mailbox at the zero-based index specified by index contains the flag named by flagName.

Flag-name comparison is case-insensitive. Include the leading backslash when checking an IMAP system flag or mailbox attribute, for example \Marked, \Noselect, or \HasChildren.

More Information and Examples

List and Inspect IMAP Mailboxes Find the "Sent" IMAP Mailbox

HasInferiors

bool HasInferiors(int index);

Returns true if the mailbox at the zero-based index specified by index either has child mailboxes or permits child mailboxes to be created beneath it.

Important distinction: \HasNoChildren means that no child mailboxes currently exist. It does not mean that children cannot be created. The IMAP \Noinferiors attribute means that child mailboxes cannot be created.

More Information and Examples

List and Inspect IMAP Mailboxes HasInferiors always True? (Why HasInferiors is Often Misunderstood)

IsMarked

bool IsMarked(int index);

Returns true if the mailbox at the zero-based index specified by index has the IMAP \Marked attribute.

\Marked is a server-provided hint that the mailbox may contain messages added since it was last selected. It is advisory information returned by the mailbox-listing operation.

More Information and Examples

List and Inspect IMAP Mailboxes

IsSelectable

bool IsSelectable(int index);

Returns true if the mailbox at the zero-based index specified by index can be selected or examined for message access.

A mailbox having the IMAP \Noselect attribute is not selectable, even though it may appear in the mailbox hierarchy and may contain selectable child mailboxes.

More Information and Examples

List and Inspect IMAP Mailboxes

LoadTaskResult

bool LoadTaskResult(CkTask &task);

Introduced in version 9.5.0.52

Loads this object from a completed asynchronous task whose result is a Mailboxes collection.

task must reference a completed Task returned by the asynchronous form of an operation that produces mailbox-listing results.

Returns true for success, false for failure.