Pascal (Lazarus/Delphi)

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 Pascal (Lazarus/Delphi) Downloads

Download Chilkat for Pascal (Lazarus/Delphi)

Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Imap,
  Chilkat.Mailboxes;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  imap: TImap;
  subscribedOnly: Boolean;
  mailboxes: TMailboxes;
  n: Integer;
  i: Integer;
  name: string;
  flags: string;
  numFlags: Integer;
  j: Integer;
  flag: string;
  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 := TImap.Create;

  imap.Ssl := True;
  imap.Port := 993;

  success := imap.Connect('imap.example.com');
  if (success = False) then
    begin
      WriteLn(imap.LastErrorText);
      Exit;
    end;
  success := imap.Login('user@example.com','myPassword');
  if (success = False) then
    begin
      WriteLn(imap.LastErrorText);
      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 := TMailboxes.Create;
  success := imap.MbxList(subscribedOnly,'','*',mailboxes);
  if (success = False) then
    begin
      WriteLn(imap.LastErrorText);
      Exit;
    end;

  //  Loop over each mailbox in the returned collection.
  n := mailboxes.Count;
  WriteLn('Number of mailboxes: ' + n);

  for i := 0 to n - 1 do
    begin
      name := mailboxes.GetName(i);
      WriteLn('Mailbox: ' + name);

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

      //  Whether the server marked the mailbox as possibly having new messages.
      if (mailboxes.IsMarked(i)) then
        begin
          WriteLn('  Marked: yes');
        end;

      //  Whether the mailbox has, or may contain, child mailboxes.
      if (mailboxes.HasInferiors(i)) then
        begin
          WriteLn('  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 (mailboxes.HasFlag(i,'\\HasChildren')) then
        begin
          WriteLn('  Has child mailboxes');
        end;

      //  Get all of the mailbox's flags as a comma-separated string.
      flags := mailboxes.GetFlags(i);
      WriteLn('  Flags: ' + flags);

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

      for j := 0 to numFlags - 1 do
        begin
          flag := mailboxes.GetNthFlag(i,j);
          WriteLn('    Flag ' + j + ': ' + flag);
        end;

    end;

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

  success := imap.Disconnect();
  if (success = False) then
    begin
      WriteLn(imap.LastErrorText);
      Exit;
    end;


  imap.Free;
  mailboxes.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.