(Delphi DLL) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

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

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
imap: HCkImap;
success: Boolean;
refName: PWideChar;
wildcardedMailbox: PWideChar;
mboxes: HCkMailboxes;
i: Integer;

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

imap := CkImap_Create();

// Connect to an IMAP server.
// Use TLS
CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);
success := CkImap_Connect(imap,'imap.someMailServer.com');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Login
success := CkImap_Login(imap,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// First examine the already subscribed mailboxes.
refName := '';
wildcardedMailbox := '*';

// Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
mboxes := CkImap_ListSubscribed(imap,refName,wildcardedMailbox);
if (CkImap_getLastMethodSuccess(imap) <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

for i := 0 to CkMailboxes_getCount(mboxes) - 1 do
  begin
    Memo1.Lines.Add(CkMailboxes__getName(mboxes,i));
  end;

Memo1.Lines.Add('----');
CkMailboxes_Dispose(mboxes);

// Sample output.

// INBOX
// INBOX/recent
// INBOX/misc
// INBOX/misc/solutions
// ...
// Outbox
// Deleted Items
// Sent Items
// Drafts
// Junk E-mail
// Trash
// Sent
// Templates

// Let's unsubscribe to "INBOX/misc/solutions".
success := CkImap_Unsubscribe(imap,'INBOX/misc/solutions');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
mboxes := CkImap_ListSubscribed(imap,'','INBOX/misc*');
if (CkImap_getLastMethodSuccess(imap) <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

for i := 0 to CkMailboxes_getCount(mboxes) - 1 do
  begin
    Memo1.Lines.Add(CkMailboxes__getName(mboxes,i));
  end;

CkMailboxes_Dispose(mboxes);
Memo1.Lines.Add('----');

// Re-subscribe to "INBOX/misc/solutions".
success := CkImap_Subscribe(imap,'INBOX/misc/solutions');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
mboxes := CkImap_ListSubscribed(imap,'','INBOX/misc*');
if (CkImap_getLastMethodSuccess(imap) <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

for i := 0 to CkMailboxes_getCount(mboxes) - 1 do
  begin
    Memo1.Lines.Add(CkMailboxes__getName(mboxes,i));
  end;

CkMailboxes_Dispose(mboxes);
Memo1.Lines.Add('----');

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

CkImap_Dispose(imap);

end;