---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: Mailboxes
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkMailboxesRef.html
---
# Chilkat Mailboxes — Delphi DLL — v11.7.0

> Chilkat 11.7.0 · language=delphidll · class=Mailboxes
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Mailboxes.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/guide.md`.

## Purpose

**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](https://www.chilkatsoft.com/mailboxes_class_overview.asp).

## Object creation, unlocking and error handling

**Create/Dispose**

```pascal
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.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Delphi DLL.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `procedure CkMailboxes_getDebugLogFilePath(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall; procedure CkMailboxes_putDebugLogFilePath(objHandle: HCkMailboxes; newPropVal: PWideChar); stdcall; function CkMailboxes__debugLogFilePath(objHandle: HCkMailboxes): PWideChar; stdcall;` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `procedure CkMailboxes_getLastErrorHtml(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall; function CkMailboxes__lastErrorHtml(objHandle: HCkMailboxes): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkMailboxes_getLastErrorText(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall; function CkMailboxes__lastErrorText(objHandle: HCkMailboxes): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkMailboxes_getLastErrorXml(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall; function CkMailboxes__lastErrorXml(objHandle: HCkMailboxes): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkMailboxes_getLastMethodSuccess(objHandle: HCkMailboxes): wordbool; stdcall; procedure CkMailboxes_putLastMethodSuccess(objHandle: HCkMailboxes; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkMailboxes_getVerboseLogging(objHandle: HCkMailboxes): wordbool; stdcall; procedure CkMailboxes_putVerboseLogging(objHandle: HCkMailboxes; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkMailboxes_getVersion(objHandle: HCkMailboxes; outPropVal: HCkString); stdcall; function CkMailboxes__version(objHandle: HCkMailboxes): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Count` | property, read-only | `function CkMailboxes_getCount(objHandle: HCkMailboxes): Integer; stdcall;` |
| `GetFlags` | method | `function CkMailboxes_GetFlags(objHandle: HCkMailboxes;     index: Integer;     outStr: HCkString): wordbool; stdcall; function CkMailboxes__getFlags(objHandle: HCkMailboxes;     index: Integer): PWideChar; stdcall;` |
| `GetMailboxIndex` | method | `function CkMailboxes_GetMailboxIndex(objHandle: HCkMailboxes;     mbxName: PWideChar): Integer; stdcall;` |
| `GetName` | method | `function CkMailboxes_GetName(objHandle: HCkMailboxes;     index: Integer;     outStrName: HCkString): wordbool; stdcall; function CkMailboxes__getName(objHandle: HCkMailboxes;     index: Integer): PWideChar; stdcall;` |
| `GetNthFlag` | method | `function CkMailboxes_GetNthFlag(objHandle: HCkMailboxes;     index: Integer;     flagIndex: Integer;     outStr: HCkString): wordbool; stdcall; function CkMailboxes__getNthFlag(objHandle: HCkMailboxes;     index: Integer;     flagIndex: Integer): PWideChar; stdcall;` |
| `GetNumFlags` | method | `function CkMailboxes_GetNumFlags(objHandle: HCkMailboxes;     index: Integer): Integer; stdcall;` |
| `HasFlag` | method | `function CkMailboxes_HasFlag(objHandle: HCkMailboxes;     index: Integer;     flagName: PWideChar): wordbool; stdcall;` |
| `HasInferiors` | method | `function CkMailboxes_HasInferiors(objHandle: HCkMailboxes;     index: Integer): wordbool; stdcall;` |
| `IsMarked` | method | `function CkMailboxes_IsMarked(objHandle: HCkMailboxes;     index: Integer): wordbool; stdcall;` |
| `IsSelectable` | method | `function CkMailboxes_IsSelectable(objHandle: HCkMailboxes;     index: Integer): wordbool; stdcall;` |
| `LoadTaskResult` | method | `function CkMailboxes_LoadTaskResult(objHandle: HCkMailboxes;     task: HCkTask): wordbool; stdcall;` |

## Properties

### Mailboxes.Count

`Chilkat 11.7.0 · delphidll · Mailboxes · Count · property · read-only`

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

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.

## Methods

### Mailboxes.GetFlags

`Chilkat 11.7.0 · delphidll · Mailboxes · GetFlags · method`

```pascal
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 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.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### Mailboxes.GetMailboxIndex

`Chilkat 11.7.0 · delphidll · Mailboxes · GetMailboxIndex · method`

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

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

### Mailboxes.GetName

`Chilkat 11.7.0 · delphidll · Mailboxes · GetName · method`

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

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.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### Mailboxes.GetNthFlag

`Chilkat 11.7.0 · delphidll · Mailboxes · GetNthFlag · method`

```pascal
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 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.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### Mailboxes.GetNumFlags

`Chilkat 11.7.0 · delphidll · Mailboxes · GetNumFlags · method`

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

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.

### Mailboxes.HasFlag

`Chilkat 11.7.0 · delphidll · Mailboxes · HasFlag · method`

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

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

### Mailboxes.HasInferiors

`Chilkat 11.7.0 · delphidll · Mailboxes · HasInferiors · method`

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

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.

### Mailboxes.IsMarked

`Chilkat 11.7.0 · delphidll · Mailboxes · IsMarked · method`

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

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.

### Mailboxes.IsSelectable

`Chilkat 11.7.0 · delphidll · Mailboxes · IsSelectable · method`

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

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.

### Mailboxes.LoadTaskResult

`Chilkat 11.7.0 · delphidll · Mailboxes · LoadTaskResult · method · since 9.5.0.52`

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

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.

## Related classes

[`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/Task.md)

