TMailboxes Delphi ActiveX Reference Documentation

TMailboxes

Represents a collection of IMAP mailboxes.

Importing the Chilkat ActiveX into Delphi

Important: Whenever upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) will be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

// This is the new standard way of instantiating Chilkat ActiveX objects in Delphi.
// If this syntax produces an error, download and test using the latest version of Chilkat.

var
obj: TMailboxes;
...
begin
obj := TMailboxes.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

property Count: Integer readonly

The number of mailboxes in the collection.

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

Methods

function GetFlags(index: Integer): WideString;

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

Returns a zero-length WideString on failure

function GetMailboxIndex(mbxName: WideString): Integer;

Returns the index of the mailbox having the specified name.

function GetName(index: Integer): WideString;

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

Returns a zero-length WideString on failure

function GetNthFlag(index: Integer; flagIndex: Integer): WideString;

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 a zero-length WideString on failure

function GetNumFlags(index: Integer): Integer;

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

function HasFlag(index: Integer; flagName: WideString): Integer;

Returns 1 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.

function HasInferiors(index: Integer): Integer;

Returns 1 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.

HasInferiors always True? (Why HasInferiors is Often Misunderstood)

function IsMarked(index: Integer): Integer;

Returns 1 if the Nth mailbox is marked.

function IsSelectable(index: Integer): Integer;

Returns 1 if the Nth mailbox is selectable.

function LoadTaskResult(task: TChilkatTask): Integer;

Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.