Visual C++ - 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.

Installation

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 Visual C++ console project named “receiveemail” at first, and then add the reference of EAGetMail in your project.

Visual C++ console project

To use EAGetMail POP3 & IMAP4 ActiveX Object in your project, the first step is “Add header files of EAGetMail to your project”. Please go to C:\Program Files\EAGetMail\Include\tlh or C:\Program Files (x86)\EAGetMail\Include\tlh folder, find eagetmailobj.tlh and eagetmailobj.tli, and then copy these files to your project folder. You can start to use it to retrieve email and parse email in your project.

add reference in C++

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 https://portal.azure.com.

Important

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
  • When the Register an application page appears, enter your application’s registration information:

    azure portal app registration information
    • Name - Enter a meaningful application name that will be displayed to users of the app.
    • Supported account types - Select which accounts you would like your application to support. Because we need to support all Office 365 and LIVE SDK (hotmail, outlook personal account) select Accounts "in any organizational directory and personal Microsoft accounts".
  • Redirect URI (optional)

    Select the type of app you’re building, Web or Public client (mobile & desktop), and then enter the redirect URI (or reply URL) for your application.

    For web applications, provide the base URL of your app. For example, http://localhost:31544 might be the URL for a web app running on your local machine. Users would use this URL to sign in to a web client application.

    For public client applications, provide the URI used by Azure AD to return token responses. Enter a value specific to your application, such as myapp://auth.

  • Client Id/secrets

    After you registered your application, Azure AD assigns a unique application (client) ID to your app, and you’re taken to your application’s Overview page. click "Certificates and secrets" -> "client secrets" and add a new client secret.

Important

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

API Permission

  • Click "API Permission" -> "Add a permission" -> "Exchange" -> "Application permissions" -> "Check full_access_as_app";
  • "Add a permission" -> "Microsoft Graph" -> "Delegated Permission" -> "User.Read", "email", "offline_access", "openid" and "profile".
azure app api permission

Authentication

  • Click "Authentication"

    • Implicit grant: check "Access tokens" and "ID tokens";
    • Redirect URI: input the url to get authorization code, for native desktop application, you don’t have to add redirect uri.
  • Mobile and desktop applications -> Redirect Uri, please check or add the following URI.

    https://login.microsoftonline.com/common/oauth2/nativeclient
    https://login.live.com/oauth20_desktop.srf
    http://127.0.0.1
    

    Note

    • https://login.live.com/oauth20_desktop.srf is used for Live SDK, http://127.0.0.1 is used for local Http Listener.
  • Supported account types:

    Select Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)

  • Advanced settings:

    Set both "Live SDK Support" and "Treat application as a public client" to "Yes".

azure app authentication Overview

Above client id and client secret support both "Office365 + EWS" and "Live (hotmail, outlook personal account) + IMAP", Office365 OAuth doesn’t support IMAP with Application permissions, only EWS is supported.

Visual C++ - Retrieve Email using Microsoft OAuth 2.0 from Office 365 Account in Background Service - Example

#include "stdafx.h" // pre-compile header

#include <stdio.h>
#include <tchar.h>

#include "C:\Program Files (x86)\EAGetMail\Include\tlh\EAGetMailObj.tlh"
using namespace EAGetMailObjLib;

#include "C:\Program Files (x86)\EAGetMail\Include\tlh\msxml3.tlh"
using namespace MSXML2;

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

const int MailServerAuthLogin = 0;
const int MailServerAuthCRAM5 = 1;
const int MailServerAuthNTLM = 2;
const int MailServerAuthXOAUTH2 = 3;

const int GetMailInfos_All = 1;
const int GetMailInfos_NewOnly = 2;
const int GetMailInfos_ReadOnly = 4;
const int GetMailInfos_SeqRange = 8;
const int GetMailInfos_UIDRange = 16;
const int GetMailInfos_PR_ENTRYID = 32;
const int GetMailInfos_DateRange = 64;
const int GetMailInfos_OrderByDateTime = 128;

DWORD  _getCurrentPath(LPTSTR lpPath, DWORD nSize)
{
    DWORD dwSize = ::GetModuleFileName(NULL, lpPath, nSize);
    if (dwSize == 0 || dwSize == nSize)
    {
        return 0;
    }

    // Change file name to current full path
    LPCTSTR psz = _tcsrchr(lpPath, _T('\\'));
    if (psz != NULL)
    {
        lpPath[psz - lpPath] = _T('\0');
        return _tcslen(lpPath);
    }

    return 0;
}

BOOL RequestAccessToken(const char* requestData, _bstr_t &accessToken)
{
    try
    {
        IServerXMLHTTPRequestPtr httpRequest = NULL;
        httpRequest.CreateInstance(__uuidof(MSXML2::ServerXMLHTTP));
        if (httpRequest == NULL)
        {
            printf("Failed to create XML HTTP Object, please make sure you install MSXML 3.0 on your machine.\r\n");
            return FALSE;
        }

        _bstr_t fullRequest = requestData;

        const char* postData = (const char*)fullRequest;
        LONG cdata = strlen(postData);
        LPSAFEARRAY psaHunk = ::SafeArrayCreateVectorEx(VT_UI1, 0, cdata, NULL);
        for (LONG k = 0; k < (int)cdata; k++)
        {
            BYTE ch = (BYTE)postData[k];
            ::SafeArrayPutElement(psaHunk, &k, &ch);
        }

        _variant_t requestBuffer;
        requestBuffer.vt = (VT_ARRAY | VT_UI1);
        requestBuffer.parray = psaHunk;

        // 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 https://portal.azure.com/ - Azure Active Directory.
        const char* tenant_id = "79a42c6f-5a9a-439b-a2ca-7aa1b0ed9776";

        _variant_t async(true);
        _bstr_t tokenUri("https://login.microsoftonline.com/");
        tokenUri += _bstr_t(tenant_id);
        tokenUri += _bstr_t("/oauth2/v2.0/token");

        httpRequest->setOption((MSXML2::SERVERXMLHTTP_OPTION)2, 13056);
        httpRequest->open(L"POST", tokenUri, async, vtMissing, vtMissing);
        httpRequest->setRequestHeader(L"Content-Type", L"application/x-www-form-urlencoded");
        httpRequest->send(requestBuffer);

        while (httpRequest->readyState != 4) {
            httpRequest->waitForResponse(1);
        }

        long status = httpRequest->status;
        _bstr_t responseText = httpRequest->responseText;

        if (status < 200 || status >= 300)
        {
            printf("Failed to get access token from server: %d %s\r\n", status, (const char*)responseText);
            return FALSE;
        }

        IOAuthResponseParserPtr oauthParser = NULL;
        oauthParser.CreateInstance(__uuidof(EAGetMailObjLib::OAuthResponseParser));
        oauthParser->Load(responseText);

        accessToken = oauthParser->AccessToken;
        if (accessToken.length() == 0)
        {
            printf("Failed to parse access token from server response: %d %s\r\n", status, (const char*)responseText);
            return FALSE;
        }

        return TRUE;
    }
    catch (_com_error &ep)
    {
        printf("Failed to get access token: %s", (const char*)ep.Description());
        return FALSE;
    }
}

_bstr_t GenerateRequestData()
{
    // You should create your client id and client secret,
    // do not use the following client id in production environment, it is used for test purpose only.
    const char* client_id = "8f54719b-4070-41ae-91ad-f48e3c793c5f";
    const char* client_secret = "cbmYyGQjz[d29wL2ArcgoO7HLwJXL/-.";
    const char* scope = "https://outlook.office365.com/.default";

    _bstr_t buffer = "client_id=";
    buffer += client_id;
    buffer += "&client_secret=";
    buffer += client_secret;
    buffer += "&scope=";
    buffer += scope;
    buffer += "&grant_type=client_credentials";

    return buffer;
}

void RetrieveEmail()
{
    ::CoInitialize(NULL);

    _bstr_t accessToken;
    // request access token from MS server without user interaction
    if (!RequestAccessToken((const char*)GenerateRequestData(), accessToken))
    {
        return;
    }

    const char* Office365User = "user@mydomain.onmicrosoft.com";

    try
    {
        TCHAR szPath[MAX_PATH + 1];
        _getCurrentPath(szPath, MAX_PATH);

        TCHAR szMailBox[MAX_PATH + 1];
        wsprintf(szMailBox, _T("%s\\inbox"), szPath);

        // Create a folder to store emails
        ::CreateDirectory(szMailBox, NULL);

        IMailServerPtr oServer = NULL;
        oServer.CreateInstance(__uuidof(EAGetMailObjLib::MailServer));

        // Office365 server address
        oServer->Server = _bstr_t("outlook.office365.com");
        oServer->User = _bstr_t(Office365User);

        // Use access token as password
        oServer->Password = accessToken;
        // Use OAUTH 2.0
        oServer->AuthType = MailServerAuthXOAUTH2;
        // Use EWS Protocol
        oServer->Protocol = MailServerEWS;

        // Enable SSL Connection
        oServer->SSLConnection = VARIANT_TRUE;

        IMailClientPtr oClient = NULL;
        oClient.CreateInstance(__uuidof(EAGetMailObjLib::MailClient));
        oClient->LicenseCode = _T("TryIt");

        _tprintf(_T("Connecting %s ...\r\n"), (const TCHAR*)oServer->Server);
        oClient->Connect(oServer);

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

        IMailInfoCollectionPtr infos = oClient->GetMailInfoList();
        _tprintf(_T("Total %d emails\r\n"), infos->Count);

        for (long i = 0; i < infos->Count; i++)
        {
            IMailInfoPtr pInfo = infos->GetItem(i);

            _tprintf(_T("Index: %d; Size: %d; UIDL: %s\r\n\r\n"),
                pInfo->Index, pInfo->Size, (const TCHAR*)pInfo->UIDL);

            TCHAR szFile[MAX_PATH + 1];
            // Generate a random file name by current local datetime,
            // You can use your method to generate the filename if you do not like it
            SYSTEMTIME curtm;
            ::GetLocalTime(&curtm);
            ::wsprintf(szFile, _T("%s\\%04d%02d%02d%02d%02d%02d%03d%d.eml"),
                szMailBox,
                curtm.wYear,
                curtm.wMonth,
                curtm.wDay,
                curtm.wHour,
                curtm.wMinute,
                curtm.wSecond,
                curtm.wMilliseconds,
                i);

            // Receive email from POP3 server
            IMailPtr oMail = oClient->GetMail(pInfo);

            _tprintf(_T("From: %s\r\n"), (const TCHAR*)oMail->From->Address);
            _tprintf(_T("Subject: %s\r\n"), (const TCHAR*)oMail->Subject);

            // Save email to local disk
            oMail->SaveAs(szFile, VARIANT_TRUE);

            // Mark email as read to prevent retrieving this email again.
            oClient->MarkAsRead(pInfo, VARIANT_TRUE);

            // If you want to delete current email, please use Delete method instead of MarkAsRead
            // oClient->Delete(pInfo);
        }

        // Delete method just mark the email as deleted,
        // Quit method expunge the emails from server exactly.
        oClient->Quit();
    }
    catch (_com_error &ep)
    {
        _tprintf(_T("Error: %s\r\n"), (const TCHAR*)ep.Description());
    }

}

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

Appendix

Comments

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