Mailboxes Delphi DLL Reference Documentation

Mailboxes

Current Version: 11.5.0

Requires Chilkat Bundle License

Chilkat.Mailboxes

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

Chilkat.Mailboxes represents a collection of IMAP mailboxes returned by Chilkat.Imap. It provides indexed access to mailbox names and mailbox attributes, including mailbox flags, selectable status, marked status, whether child mailboxes exist, and whether child mailboxes may be created. It is a lightweight result object used for listing and examining the mailbox hierarchy on an IMAP server.

Mailbox collection

Hold the list of IMAP mailboxes returned by mailbox-listing operations in Chilkat.Imap.

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 a mailbox-listing method on Chilkat.Imap, receive a Mailboxes object, loop from 0 to Count - 1, retrieve each mailbox name, and inspect its flags or selectable status before selecting, creating, or displaying mailboxes in the application.

For an extended overview, see Mailboxes Class Overview.

Create/Dispose

var
myObject: HCkMailboxes;

begin
myObject := CkMailboxes_Create();

// ...

CkMailboxes_Dispose(myObject);
end;

function CkMailboxes_Create: HCkMailboxes; stdcall;

Creates an instance of the HCkMailboxes object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkMailboxes_Dispose(handle: HCkMailboxes); stdcall;

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.

Properties

Count

function CkMailboxes_getCount(objHandle: HCkMailboxes): Integer; stdcall;

The number of mailboxes in the collection.

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

DebugLogFilePath

procedure CkMailboxes_getDebugLogFilePath(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall;
procedure CkMailboxes_putDebugLogFilePath(objHandle: HCkMailboxes; newPropVal: PWideChar); stdcall;
function CkMailboxes__debugLogFilePath(objHandle: HCkMailboxes): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkMailboxes_getLastErrorHtml(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall;
function CkMailboxes__lastErrorHtml(objHandle: HCkMailboxes): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkMailboxes_getLastErrorText(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall;
function CkMailboxes__lastErrorText(objHandle: HCkMailboxes): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkMailboxes_getLastErrorXml(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall;
function CkMailboxes__lastErrorXml(objHandle: HCkMailboxes): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkMailboxes_getLastMethodSuccess(objHandle: HCkMailboxes): wordbool; stdcall;
procedure CkMailboxes_putLastMethodSuccess(objHandle: HCkMailboxes; newPropVal: wordbool); stdcall;

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.

VerboseLogging

function CkMailboxes_getVerboseLogging(objHandle: HCkMailboxes): wordbool; stdcall;
procedure CkMailboxes_putVerboseLogging(objHandle: HCkMailboxes; newPropVal: wordbool); stdcall;

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

procedure CkMailboxes_getVersion(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall;
function CkMailboxes__version(objHandle: HCkMailboxes): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetFlags

function CkMailboxes_GetFlags(objHandle: HCkMailboxes;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkMailboxes__getFlags(objHandle: HCkMailboxes;
    index: Integer): PWideChar; stdcall;

Returns a comma-separated list of flags for the Nth mailbox. For example, \HasNoChildren,\Important.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetMailboxIndex

function CkMailboxes_GetMailboxIndex(objHandle: HCkMailboxes;
mbxName: PWideChar): Integer; stdcall;

Returns the index of the mailbox having the specified name.

GetName

function CkMailboxes_GetName(objHandle: HCkMailboxes;
    index: Integer;
    outStrName: HCkString): wordbool; stdcall;
function CkMailboxes__getName(objHandle: HCkMailboxes;
    index: Integer): PWideChar; stdcall;

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

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetNthFlag

function CkMailboxes_GetNthFlag(objHandle: HCkMailboxes;
    index: Integer;
    flagIndex: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkMailboxes__getNthFlag(objHandle: HCkMailboxes;
    index: Integer;
    flagIndex: Integer): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

GetNumFlags

function CkMailboxes_GetNumFlags(objHandle: HCkMailboxes;
index: Integer): Integer; stdcall;

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

HasFlag

function CkMailboxes_HasFlag(objHandle: HCkMailboxes;
index: Integer;
flagName: PWideChar): wordbool; stdcall;

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.

More Information and Examples

Find the "Sent" IMAP Mailbox

HasInferiors

function CkMailboxes_HasInferiors(objHandle: HCkMailboxes;
index: Integer): wordbool; stdcall;

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.

More Information and Examples

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

IsMarked

function CkMailboxes_IsMarked(objHandle: HCkMailboxes;
index: Integer): wordbool; stdcall;

Returns True if the Nth mailbox is marked.

IsSelectable

function CkMailboxes_IsSelectable(objHandle: HCkMailboxes;
index: Integer): wordbool; stdcall;

Returns True if the Nth mailbox is selectable.

LoadTaskResult

function CkMailboxes_LoadTaskResult(objHandle: HCkMailboxes;
task: HCkTask): wordbool; stdcall;

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns True for success, False for failure.