Mailboxes Delphi DLL Reference Documentation

Mailboxes

Current Version: 9.5.0.79

Represents a collection of IMAP mailboxes.

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.

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

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.

top

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.

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

Returns the index of the mailbox having the specified name.

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

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

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

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

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

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

Returns True if the Nth mailbox is marked.

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

Returns True if the Nth mailbox is selectable.

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

top