Delphi DLL

List and Inspect IMAP Mailboxes

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
imap: HCkImap;
subscribedOnly: Boolean;
mailboxes: HCkMailboxes;
n: Integer;
i: Integer;
name: PWideChar;
flags: PWideChar;
numFlags: Integer;
j: Integer;
flag: PWideChar;
sentIndex: Integer;

begin
success := False;

//  Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
//  over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
//  result collection -- applications inspect the entries but do not add, remove, or modify them.

imap := CkImap_Create();

CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);

success := CkImap_Connect(imap,'imap.example.com');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;
success := CkImap_Login(imap,'user@example.com','myPassword');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

//  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
//  all mailboxes (not subscribed-only) and "*" matches any name.
subscribedOnly := False;
mailboxes := CkMailboxes_Create();
success := CkImap_MbxList(imap,subscribedOnly,'','*',mailboxes);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

//  Loop over each mailbox in the returned collection.
n := CkMailboxes_getCount(mailboxes);
Memo1.Lines.Add('Number of mailboxes: ' + IntToStr(n));

for i := 0 to n - 1 do
  begin
    name := CkMailboxes__getName(mailboxes,i);
    Memo1.Lines.Add('Mailbox: ' + name);

    //  Whether the mailbox can be selected or examined for message access.
    if (CkMailboxes_IsSelectable(mailboxes,i)) then
      begin
        Memo1.Lines.Add('  Selectable: yes');
      end
    else
      begin
        Memo1.Lines.Add('  Selectable: no');
      end;

    //  Whether the server marked the mailbox as possibly having new messages.
    if (CkMailboxes_IsMarked(mailboxes,i)) then
      begin
        Memo1.Lines.Add('  Marked: yes');
      end;

    //  Whether the mailbox has, or may contain, child mailboxes.
    if (CkMailboxes_HasInferiors(mailboxes,i)) then
      begin
        Memo1.Lines.Add('  May have child mailboxes');
      end;

    //  Check for a specific flag by name.  Include the leading backslash for a system flag;
    //  in CkScript a literal backslash in a string is written as "\\".
    if (CkMailboxes_HasFlag(mailboxes,i,'\\HasChildren')) then
      begin
        Memo1.Lines.Add('  Has child mailboxes');
      end;

    //  Get all of the mailbox's flags as a comma-separated string.
    flags := CkMailboxes__getFlags(mailboxes,i);
    Memo1.Lines.Add('  Flags: ' + flags);

    //  Iterate the flags individually.
    numFlags := CkMailboxes_GetNumFlags(mailboxes,i);

    for j := 0 to numFlags - 1 do
      begin
        flag := CkMailboxes__getNthFlag(mailboxes,i,j);
        Memo1.Lines.Add('    Flag ' + IntToStr(j) + ': ' + flag);
      end;

  end;

//  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
sentIndex := CkMailboxes_GetMailboxIndex(mailboxes,'Sent');
if (sentIndex >= 0) then
  begin
    Memo1.Lines.Add('The Sent mailbox is at index ' + IntToStr(sentIndex));
  end;

success := CkImap_Disconnect(imap);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

CkImap_Dispose(imap);
CkMailboxes_Dispose(mailboxes);