(Delphi DLL) Office365 IMAP List Mailboxes

See more Office365 Examples

List the Office365 IMAP mailboxes.

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, Mailboxes, Imap, JsonObject;

...

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

begin
// An Office365 OAuth2 access token must first be obtained prior
// to running this code.

// Getting the OAuth2 access token for the 1st time requires the O365 account owner's 
// interactive authorizaition via a web browser.  Afterwards, the access token
// can be repeatedly refreshed automatically.

// See the following examples for getting and refreshing an OAuth2 access token

// Get Office365 SMTP/IMAP/POP3 OAuth2 Access Token
// Refresh Office365 SMTP/IMAP/POP3 OAuth2 Access Token

// First get our previously obtained OAuth2 access token.
jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/office365.json');
if (success = False) then
  begin
    Memo1.Lines.Add('Failed to open the office365 OAuth JSON file.');
    Exit;
  end;

imap := CkImap_Create();

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

// Connect to the Office365 IMAP server.
success := CkImap_Connect(imap,'outlook.office365.com');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Use OAuth2 authentication.
CkImap_putAuthMethod(imap,'XOAUTH2');

// Login using our username (i.e. email address) and the access token for the password.
success := CkImap_Login(imap,'OFFICE365_EMAIL_ADDRESS',CkJsonObject__stringOf(jsonToken,'access_token'));
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

Memo1.Lines.Add('O365 OAuth authentication is successful.');

// 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 := CkImap_ListMailboxes(imap,refName,wildcardedMailbox);
if (CkImap_getLastMethodSuccess(imap) = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

i := 0;
while i < CkMailboxes_getCount(mboxes) do
  begin
    Memo1.Lines.Add(CkMailboxes__getName(mboxes,i));
    i := i + 1;
  end;

// Sample output looks like this:
// Archive
// Calendar
// Calendar/Birthdays
// Calendar/United States holidays
// Contacts
// Conversation History
// Deleted Items
// Drafts
// INBOX
// INBOX/abc
// INBOX/misc
// INBOX/misc/birdeye
// INBOX/old
// INBOX/old/large
// INBOX/receipts
// Journal
// Junk Email
// Notes
// Outbox
// RSS Subscriptions
// Sent Items
// Sync Issues
// Sync Issues/Conflicts
// Sync Issues/Local Failures
// Sync Issues/Server Failures
// Tasks
// Trash

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

CkMailboxes_Dispose(mboxes);

CkJsonObject_Dispose(jsonToken);
CkImap_Dispose(imap);

end;