C#/ASP.NET/ASP MVC - 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.

Install from NuGet

You can also install the run-time assembly by NuGet. Run the following command in the NuGet Package Manager Console:

Install-Package EAGetMail

Note

If you install it by NuGet, no sample projects are installed, only .NET assembly is installed.

Add reference

To use EAGetMail POP3 & IMAP Component in your project, the first step is “Add reference of EAGetMail to your project”. Please create or open your project with Visual Studio, then go to menu -> Project -> Add Reference -> .NET -> Browse..., and select Installation path\Lib\[netversion]\EAGetMail.dll, click Open-> OK, the reference will be added to the project, you can start to use it to retrieve email and parse email in your project.

add reference in c#/vb.net/managed c++/cli

.NET assembly

Because EAGetMail has separate builds for .Net Framework, please refer to the following table and choose the correct dll.

Separate builds of run-time assembly for .Net Framework 1.1, 2.0, 3.5, 4.0, 4.5, 4.61, .NET Core 2.1 and .Net Compact Framework 2.0, 3.5.

File .NET Framework Version
Lib\net11\EAGetMail.dll Built with .NET Framework 1.1
It requires .NET Framework 1.1, 2.0, 3.5 or later version.
Lib\net20\EAGetMail.dll Built with .NET Framework 2.0
It requires .NET Framework 2.0, 3.5 or later version.
Lib\net35\EAGetMail.dll Built with .NET Framework 3.5
It requires .NET Framework 3.5 or later version.
Lib\net40\EAGetMail.dll Built with .NET Framework 4.0
It requires .NET Framework 4.0 or later version.
Lib\net45\EAGetMail.dll Built with .NET Framework 4.5
It requires .NET Framework 4.5 or later version.
Lib\net461\EAGetMail.dll Built with .NET Framework 4.6.1
It requires .NET Framework 4.6.1 or later version.
Lib\netcoreapp2.1\EAGetMail.dll Built with .NET Core 2.1
It requires .NET Core 2.1 or later version.
Lib\net20-cf\EAGetMail.dll Built with .NET Compact Framework 2.0
It requires .NET Compact Framework 2.0, 3.5 or later version.
Lib\net35-cf\EAGetMail.dll Built with .NET Compact Framework 3.5
It requires .NET Compact Framework 3.5 or later version.

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.

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

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 (hotmail.com, outlook.com), 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.

Important

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.

Important

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

Important

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.

Important

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.

C#/ASP.NET/ASP MVC - Retrieve email using Microsoft OAuth 2.0 from Office 365 account in background service - example

using System;
using System.Text;
using System.IO;
using System.Net;
using System.Globalization;
using EAGetMail;

// Generate an unqiue email file name based on date time
static string _generateFileName(int sequence)
{
    DateTime currentDateTime = DateTime.Now;
    return string.Format("{0}-{1:000}-{2:000}.eml",
        currentDateTime.ToString("yyyyMMddHHmmss", new CultureInfo("en-US")),
        currentDateTime.Millisecond,
        sequence);
}

static string _postString(string uri, string requestData)
{
    HttpWebRequest httpRequest = WebRequest.Create(uri) as HttpWebRequest;
    httpRequest.Method = "POST";
    httpRequest.ContentType = "application/x-www-form-urlencoded";

    using (Stream requestStream = httpRequest.GetRequestStream())
    {
        byte[] requestBuffer = Encoding.UTF8.GetBytes(requestData);
        requestStream.Write(requestBuffer, 0, requestBuffer.Length);
        requestStream.Close();
    }

    try
    {
        HttpWebResponse httpResponse = httpRequest.GetResponse() as HttpWebResponse;
        using (StreamReader reader = new StreamReader(httpResponse.GetResponseStream()))
        {
            // reads response body
            string responseText = reader.ReadToEnd();
            Console.WriteLine(responseText);
            return responseText;
        }
    }
    catch (WebException ex)
    {
        if (ex.Status == WebExceptionStatus.ProtocolError)
        {
            var response = ex.Response as HttpWebResponse;
            if (response != null)
            {
                Console.WriteLine("HTTP: " + response.StatusCode);
                using (StreamReader reader = new StreamReader(response.GetResponseStream()))
                {
                    // reads response body
                    string responseText = reader.ReadToEnd();
                    Console.WriteLine(responseText);
                }
            }
        }

        throw ex;
    }
}

public static void RetrieveEmail()
{
    try
    {
        string client_id = "8f54719b-4070-41ae-91ad-f48e3c793c5f";
        string client_secret = "cbmYyGQjz[d29wL2ArcgoO7HLwJXL/-.";

        // 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.
        string tenant = "79a42c6f-5a9a-439b-a2ca-7aa1b0ed9776";

        string requestData =
            string.Format("client_id={0}&client_secret={1}&scope=https://outlook.office365.com/.default&grant_type=client_credentials",
                client_id, client_secret);

        string tokenUri = string.Format("https://login.microsoftonline.com/{0}/oauth2/v2.0/token", tenant);
        string responseText = _postString(tokenUri, requestData);

        OAuthResponseParser parser = new OAuthResponseParser();
        parser.Load(responseText);

        string officeUser = "user@mydomain.onmicrosoft.com";
        // Create a folder named "inbox" under current directory
        // to save the email retrieved.
        string localInbox = string.Format("{0}\\inbox", Directory.GetCurrentDirectory());
        // If the folder is not existed, create it.
        if (!Directory.Exists(localInbox))
        {
            Directory.CreateDirectory(localInbox);
        }

        // Office 365 server address
        MailServer oServer = new MailServer("outlook.office365.com",
                officeUser,
                parser.AccessToken, // use access token as password
                ServerProtocol.ExchangeEWS); // use Http EWS protocol

        // Set OAUTH 2.0
        oServer.AuthType = ServerAuthType.AuthXOAUTH2;
        // Enable SSL/TLS connection
        oServer.SSLConnection = true;

        MailClient oClient = new MailClient("TryIt");
        // Get new email only, if you want to get all emails, please remove this line
        oClient.GetMailInfosParam.GetMailInfosOptions = GetMailInfosOptionType.NewOnly;

        Console.WriteLine("Connecting {0} ...", oServer.Server);
        oClient.Connect(oServer);

        MailInfo[] infos = oClient.GetMailInfos();
        Console.WriteLine("Total {0} email(s)\r\n", infos.Length);

        for (int i = 0; i < infos.Length; i++)
        {
            MailInfo info = infos[i];
            Console.WriteLine("Index: {0}; Size: {1}; UIDL: {2}",
                info.Index, info.Size, info.UIDL);

            // Receive email from email server
            Mail oMail = oClient.GetMail(info);

            Console.WriteLine("From: {0}", oMail.From.ToString());
            Console.WriteLine("Subject: {0}\r\n", oMail.Subject);

            // Generate an unqiue email file name based on date time.
            string fileName = _generateFileName(i + 1);
            string fullPath = string.Format("{0}\\{1}", localInbox, fileName);

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

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

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

        // Quit and expunge emails marked as deleted from server.
        oClient.Quit();
        Console.WriteLine("Completed!");
    }
    catch (Exception ep)
    {
        Console.WriteLine(ep.ToString());
    }
}

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.