Delphi - Retrieve email using Microsoft OAuth 2.0 (Modern Authentication) + EWS protocol from Office 365 in background service

You can retrieve email using traditional user/password authentication from Office 365 account by EWS Protocol. IMAP4 protocol is not supported in background service.

However Microsoft will disable traditional user authentication in the future, switching to Microsoft OAuth (Modern Authentication) is strongly recommended now.


Before you can use the following sample codes, you should download the EAGetMail Installer and install it on your machine at first. Full sample projects are included in this installer.

Add reference

To better demonstrate how to retrieve email and parse email, let’s create a Delphi Standard EXE project at first, then add a TButton on the Form, double-click this button. It is like this:

Delphi console project

To use EAGetMail ActiveX Object in your Delphi project, the first step is “Add Unit file of EAGetMail to your project”. Please go to C:\Program Files\EAGetMail\Include\delphi or C:\Program Files (x86)\EAGetMail\Include\delphi folder, find EAGetMailObjLib_TLB.pas, and then copy this file to your project folder.

// include EAGetMailObjLib_TLB unit to your Delphi Project
unit Unit1;


Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
Dialogs, EAGetMailObjLib_TLB, StdCtrls;

Then you can start to use it in your Delphi Project.

You can also create EAGetMailObjLib_TLB.pas manually by Delphi like this:

  • Delphi 7 or eariler version

    First of all, create a standard delphi project: select menu Project -> Import Type Library, checked EAGetMail ActiveX Object and click Create Unit. Then include EAGetMailObjLib_TLB in your project.

    add reference in Delphi
  • Delphi XE or later version

    First of all, create a standard delphi project: select menu Component -> Import component... -> Import a type library -> checked EAGetMail ActiveX Object, have Generate Component Wrapper checked and click “Create Unit”. Then include EAGetMailObjLib_TLB in your project.

Office 365 OAuth 2.0 client credentials grant

Normal OAuth requires user input user/password for authentication. Obviously, it is not suitable for background service. In this case, You can use the OAuth 2.0 client credentials grant, sometimes called two-legged OAuth, to access web-hosted resources by using the identity of an application. It only works for Office365 user, it doesn’t work for personal Hotmail account.

Create your application in Azure Portal

To use Microsoft/Office365/Live OAuth (Modern Authentication) in your application, you must create a application in Azure Portal.


You can use any Microsoft user to create the application, it doesn’t require application owner is administrator in your Office365 domain. But your Office365 administrator must authorize the application to access user mailbox.

  • Sign in to the Azure portal using either a work or school account or a personal Microsoft account.
  • If your account gives you access to more than one tenant, select your account in the top right corner, and set your portal session to the Azure AD tenant that you want.
  • In the left-hand navigation pane, select the Azure Active Directory service, and then select App registrations -> New registration.
azure portal new app registration

Single tenant and multitenant in account type

When the register an application page appears, enter a meaningful application name and select the account type.

Select which accounts you would like your application to support.

  • If your application only supports the users in your directory or organization, please select Single tenant type;
  • If your application needs to support all users in Office 365 and Microsoft personal account (,, please select Multitenant type, and you must verify publisher.

Because we just need to support Offic365 user in our organization, so select Accounts in this organizational directory only (single tenant).

Do not select supporting Microsoft personal account, because there is no way to access Microsoft personal account in background service.


If you don’t verify publisher for multitenant application, your application will not request access token successfully.

API permissions

  • Click API Permission -> Microsoft Graph -> Delegated Permission -> User.Read.
  • Click API Permission -> Add a permission -> APIs in my organization uses -> Office 365 Exchange Online -> Application Permission -> Other permission -> full_access_as_app
azure APIs in my organization uses

Here is permissions list:

azure application api permission list

If your current user is not a user in a verified domain or Offic 365, you will not find Office 365 Exchange Online in API list, then you have to add this API permission manually.

  • Select Manifest in the left-hand navigation under Manage.
  • Locate the requiredResourceAccess property in the manifest, and add the following inside the square brackets ([]):
  "resourceAppId": "00000002-0000-0ff1-ce00-000000000000",
  "resourceAccess": [
          "id": "dc890d15-9560-4a4c-9b7f-a736ec74ec40",
          "type": "Role"
  • Select Save.
  • Select API permissions under Manage. Confirm that the full_access_as_app permission is listed.

Client Id and client secrets

Now we need to create a client secret for the application, click Certificates and secrets -> client secrets and add a new client secret.

azure application api permission

After client secret is created, store the client secret value to somewhere.


Please store client secret value by yourself, because it is hidden when you view it at next time.

Branding and verify publisher

Now we click Branding, you can edit your company logo, URL and application name. If your application supports multitenant (access user in all Office 365 and Microsoft personal account), you must complete the publisher verification.

It is not difficult, you can have a look at publisher verification. After publisher verification is completed, your branding is like this:

azure application Authentication Overview


You must complete the publisher verification for multitenant application, otherwise, your application will not request access token correctly.

Client id and tenant

Now you can click Overview to find your client id and tenant.

azure application client id and tenant

Access token expiration

You don’t have to request access token every time. By default, access token expiration time is 3600 seconds, you can use the access token repeatedly before it is expired.


You should create your client id and client secret, do not use the client id from example codes in production environment, it is used for test purpose. If you got "This app isn't verified" information, please click "Advanced" -> Go to ... for test.

Delphi - Retrieve email using Microsoft OAuth 2.0 from Office 365 account in background service - example

program Project1;

    Windows, Messages, SysUtils, Variants, Classes, Graphics, ActiveX, MSXML2_TLB, EAGetMailObjLib_TLB;

    MailServerPop3 = 0;
    MailServerImap4 = 1;
    MailServerEWS = 2;
    MailServerDAV = 3;

    // Auth type
    MailServerAuthLogin = 0;
    MailServerAuthCRAM5 = 1;
    MailServerAuthNTLM = 2;
    MailServerAuthXOAUTH2 = 3;


    // GetMailInfosParam Flags
    GetMailInfos_All = 1;
    GetMailInfos_NewOnly = 2;
    GetMailInfos_ReadOnly = 4;
    GetMailInfos_SeqRange = 8;
    GetMailInfos_UIDRange = 16;
    GetMailInfos_PR_ENTRYID = 32;
    GetMailInfos_DateRange = 64;
    GetMailInfos_OrderByDateTime = 128;

function RequestAccessToken(requestData: WideString): WideString;
    httpRequest: TServerXMLHTTP;
    oauthParser: TOAuthResponseParser;
    fullRequest: OleVariant;
    status: integer;
    responseText: WideString;
    accessToken: WideString;
    tokenUri, tenant_id: WideString;
    result := '';

    httpRequest := TServerXMLHTTP.Create(nil);

    fullRequest :=  requestData;

    // If your application is not created by Office365 administrator,
    // please use Office365 directory tenant id, you should ask Offic365 administrator to send it to you.
    // Office365 administrator can query tenant id in - Azure Active Directory.
    tenant_id := '79a42c6f-5a9a-439b-a2ca-7aa1b0ed9776';
    tokenUri := '' + tenant_id + '/oauth2/v2.0/token';

    httpRequest.setOption(2, 13056);'POST', tokenUri, true);
    httpRequest.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');

    while( httpRequest.readyState <> 4 ) do
            writeln('Server response timeout (access token).');

    status := httpRequest.status;
    responseText := httpRequest.responseText;

    if (status < 200) or (status >= 300) then
        writeln('Failed to get access token from server.' + responseText);

    oauthParser := TOAuthResponseParser.Create(nil);

    accessToken := oauthParser.AccessToken;

    if accessToken = '' then
        writeln('Failed to parse access token from server response.');

    result := accessToken;

function GenerateRequestData(): WideString;
    client_id: WideString = '8f54719b-4070-41ae-91ad-f48e3c793c5f';
    client_secret: WideString = 'cbmYyGQjz[d29wL2ArcgoO7HLwJXL/-.';
    scope: WideString = '';
    result := 'client_id=' + client_id
            + '&client_secret=' + client_secret
            + '&scope=' + scope
            + '&grant_type=client_credentials';

procedure RetrieveEmail();
    accessToken: WideString;
    Office365User: WideString;
    oServer: TMailServer;
    oClient: TMailClient;
    oTools: TTools;
    oMail: IMail;
    infos: IMailInfoCollection;
    oInfo: IMailInfo;
    localInbox, fileName: WideString;
    i: Integer;

        Office365User := '';

        accessToken := RequestAccessToken(GenerateRequestData());
        if accessToken = '' then

        // set current thread code page to system default code page.
        oTools := TTools.Create(nil);

        // Create a folder named "inbox" under
        // current directory to store the email files
        localInbox := GetCurrentDir() + '\inbox';

        oServer := TMailServer.Create(nil);
        // Office 365 Server
        oServer.Server := '';
        // Use OAUTH 2.0
        oServer.AuthType := MailServerAuthXOAUTH2;

        oServer.User := Office365User;
        // Use access token as password
        oServer.Password := accessToken;
        // Use EWS Protocol
        oServer.Protocol := MailServerEWS;

        // Enable SSL Connection
        oServer.SSLConnection := true;

        oClient := TMailClient.Create(nil);
        oClient.LicenseCode := 'TryIt';

        writeln('Connecting ' + oServer.Server + ' ...');

        // Get new email only, if you want to get all emails, please remove this line
        oClient.GetMailInfosParam.GetMailInfosOptions := GetMailInfos_NewOnly;

        infos := oClient.GetMailInfoList();
        writeln(Format('Total %d email(s)', [infos.Count]));

        for i := 0 to infos.Count - 1 do
            oInfo := infos.Item[i];

            writeln(Format('Index: %d; Size: %d; UIDL: ' + oInfo.UIDL,
            [oInfo.Index, oInfo.Size]));

            // Generate a random file name by current local datetime,
            // You can use your method to generate the filename if you do not like it
            fileName := localInbox + '\' + oTools.GenFileName(i) + '.eml';

            // Receive email from IMAP server
            oMail := oClient.GetMail(oInfo);

            writeln('From: ' + oMail.From.Address + #13#10 +
                'Subject: ' + oMail.Subject);

            // Save email to local disk
            oMail.SaveAs(fileName, true);

            // Mark email as read to prevent retrieving this email again.
            oClient.MarkAsRead(oInfo, true);

            // If you want to delete current email, please use Delete method instead of MarkAsRead
            // oClient.Delete(oInfo);

        // Quit and expunge emails marked as deleted from IMAP server
        on ep:Exception do
        writeln('Error: ' + ep.Message);




    writeln('  Sign in with MS OAuth');
    writeln('   If you got "This app is not verified" information in Web Browser, ');
    writeln('      click "Advanced" -> Go to ... to continue test.');

    writeln('Press ENTER key to sign in...');


    writeln('Press ENTER key to quit...');


TLS 1.2 protocol

TLS is the successor of SSL, more and more SMTP servers require TLS 1.2 encryption now.

If your operating system is Windows XP/Vista/Windows 7/Windows 2003/2008/2008 R2/2012/2012 R2, you need to enable TLS 1.2 protocol in your operating system like this:

Enable TLS 1.2 on Windows XP/Vista/7/10/Windows 2008/2008 R2/2012



If you have any comments or questions about above example codes, please click here to add your comments.