(Delphi ActiveX) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
imap: TChilkatImap;
success: Integer;
refName: WideString;
wildcardedMailbox: WideString;
mboxes: IMailboxes;
i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

imap := TChilkatImap.Create(Self);

// Connect to an IMAP server.
// Use TLS
imap.Ssl := 1;
imap.Port := 993;
success := imap.Connect('MY-IMAP-DOMAIN');
if (success <> 1) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// Login
success := imap.Login('MY-IMAP-LOGIN','MY-IMAP-PASSWORD');
if (success <> 1) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// The ListMailboxes method returns a Mailboxes object
// that contains the collection of mailboxes.
// It accepts two arguments: a refName and a wildcardedMailbox.

refName := '';
// refName is usually set to an empty string.
// A non-empty reference name argument is the name of a mailbox or a level of
// mailbox hierarchy, and indicates the context in which the mailbox
// name is interpreted.

// Select all mailboxes matching this pattern:
wildcardedMailbox := '*';

mboxes := imap.ListMailboxes(refName,wildcardedMailbox);
if (imap.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

i := 0;
while i < mboxes.Count do
  begin
    Memo1.Lines.Add(mboxes.GetName(i));
    i := i + 1;
  end;

// Sample output looks like this:
// INBOX.vendors.shareit
// INBOX.oldSupport
// INBOX.vendors.paypal
// INBOX.sales
// INBOX.lists
// INBOX.Drafts
// INBOX.vendors.dell
// INBOX.Trash
// INBOX.invoiceRequests
// INBOX.purchases
// INBOX.vendors.inMotion
// INBOX.oldEmail
// INBOX.vendors
// INBOX.lists.python
// INBOX.vendors.myhosting
// INBOX.Templates
// INBOX.friends
// INBOX.bounceSamples
// INBOX.lists.ruby
// INBOX.vendors.peer1
// INBOX.Sent
// INBOX.Junk
// INBOX

// Disconnect from the IMAP server.
success := imap.Disconnect();
end;