By default, you need to enable ” Allowing less secure apps” in Gmail, then you can retrieve email with user/password IMAP4 authentication.
However Google will disable traditional user authentication in the future, switching to Google OAuth is strongly recommended now.
Sections:
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.
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.
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 2.0, 4.0, 4.5, 4.6.1, 4.7.2, 4.8.1, .NET 6.0, NET 7.0, .NET 8.0, .NET Standard 2.0 and .Net Compact Framework 2.0, 3.5.
File | .NET Framework Version |
Lib\[net20|40|45|461|472|481]\EAGetMail.dll |
Built with .NET Framework 2.0, 4.0, 4.5, 4.6.1, 4.7.2, 4.8.1
It requires .NET Framework 2.0, 3.5 or later version. |
Lib\[net5.0|6.0|7.0|8.0]\EAGetMail.dll |
Built with .NET 5.0, .NET 6.0, .NET 7.0, .NET 8.0
It requires .NET 5.0 or later version. |
Lib\netstandard2.0\EAGetMail.dll |
Built with .NET Standard 2.0
It requires .NET Standard 2.0 or later version. |
Lib\[net20-cf|net35-cf]\EAGetMail.dll |
Built with .NET Compact Framework 2.0, 3.5
It requires .NET Compact Framework 2.0, 3.5 or later version. |
The Gmail IMAP and SMTP servers have been extended to support authorization via the industry-standard OAuth 2.0 protocol. Using OAUTH protocol, user can do authentication by Google Web Login instead of inputting user and password directly in application.
To retrieve email using Gmail OAuth in your application, you should create a project in the Google Cloud console, go to Menu menu > IAM & Admin > Create a Project:
In the Google Cloud console, go to Menu ->APIs & Services
->Dashboard
->OAuth consent screen
, selectExternal
user type, input necessary information and click Save.
APIs & Services
-> Dashboard
-> Credentials
Credentials
-> Create Credentials
-> OAuth client ID
-> Web application
or Other (Desktop Application)
. It depends on your application type."Create"
, you will get client id
and client secret
, download and save them for later use."Library"
-> Search "Gmail"
, then click "Gmail API"
and enable it."OAuth consent screen"
-> "Edit App"
..../auth/userinfo.email
, .../auth/userinfo.profile
, openid
and https://mail.google.com/
scopes in OAuth consent screen
-> Edit App
-> Scopes
-> Add or remove scopes
.Gmail supports IMAP/POP + OAuth, but the API (https://mail.google.com/
) scope is restricted API
which requests to have full access to the Gmail account. Restricted API is throttled before your project is authenticated in by Google.
If you use OAuth in a web application, you should use a web page or controller to
get authorization code from Google OAuth Server.
So you need to add your page or web application routing path to Authorized Redirect URIs
in APIs & Services
-> Dashboard
-> Credentials
->
OAuth 2.0 Client IDs
-> Your Client ID
.
By default, your app is in test mode, you should add the user email address to the test users, then the user can test your app.
Go to OAuth consent screen
-> Test users
-> Add users
-> input the user email address.
If you want to publish your app, you should submit your app for verification by clicking “Publish”.
If your users are seeing the “unverified app” screen, it is because your OAuth request includes additional scopes that haven’t been approved. The user can still choose to proceed with the request, but the app will be limited in the number of users that can grant permission to your app when requesting unapproved sensitive or restricted scopes.
Learn more detail from: https://developers.google.com/workspace/guides/create-project.
Because HttpWebRequest is used to get access token from web service.
If you’re using legacy .NET framework (.NET 2.0 - .NET 3.5 and .NET 4.0 - 4.6.1),
you need to enable Strong Encryption Algorithms
to request access token:
Put the following content to a file named NetStrongEncrypt.reg
, right-click this file -> Merge
-> Yes
.
You can also download it from https://www.emailarchitect.net/webapp/download/NetStrongEncrypt.zip.
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\v2.0.50727]
"SystemDefaultTlsVersions"=dword:00000001
"SchUseStrongCrypto"=dword:00000001
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v2.0.50727]
"SystemDefaultTlsVersions"=dword:00000001
"SchUseStrongCrypto"=dword:00000001
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\v4.0.30319]
"SystemDefaultTlsVersions"=dword:00000001
"SchUseStrongCrypto"=dword:00000001
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319]
"SystemDefaultTlsVersions"=dword:00000001
"SchUseStrongCrypto"=dword:00000001
You can use client id and client secret to get the user email address and access token like this:
EAGetMail Installation Path\Samples_{Programming language/Developer Tool}
project.You don’t have to open browser 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.
After it is expired, you can use refresh token
to refresh access token
directly without opening browser.
You can find full sample project in EAGetMail installation path
to learn how to refresh token
.
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.
Here is a console application which demonstrates how to use Google OAuth to do user authentication and retrieve email.
Note
This sample cannot handle the event of Web Browser is closed by user manually before authentication is completed.
You can refer to the better sample project which uses Web Browser Control
in EAGetMail installation path.
using System;
using System.IO;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading.Tasks;
using System.Runtime.InteropServices;
using EAGetMail;
using System.Globalization;
namespace EAGetMailCSharpKb
{
class Program
{
static void Main(string[] args)
{
Console.WriteLine("+------------------------------------------------------------------+");
Console.WriteLine(" Sign in with Google ");
Console.WriteLine(" If you got \"This app isn't verified\" information in Web Browser, ");
Console.WriteLine(" click \"Advanced\" -> Go to ... to continue test.");
Console.WriteLine("+------------------------------------------------------------------+");
Console.WriteLine("");
Console.WriteLine("Press any key to sign in...");
Console.ReadKey();
try
{
Program p = new Program();
p.DoOauthAndRetrieveEmail();
}
catch (Exception ep)
{
Console.WriteLine(ep.ToString());
}
Console.ReadKey();
}
// 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);
}
void RetrieveMailWithXOAUTH2(string userEmail, string accessToken)
{
try
{
// 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);
}
MailServer oServer = new MailServer("imap.gmail.com",
userEmail,
accessToken, // use access token as password
ServerProtocol.Imap4);
// Set IMAP OAUTH 2.0
oServer.AuthType = ServerAuthType.AuthXOAUTH2;
// Enable SSL/TLS connection, most modern email server require SSL/TLS by default
oServer.SSLConnection = true;
// Set IMAP4 SSL Port
oServer.Port = 993;
// Since EAGetMail 5.3.5, Gmail Rest API is supported as well. You can use the following code
// to retrieve email using Gmail Rest API.
// MailServer oServer = new MailServer("gmail.googleapis.com",
// userEmail,
// accessToken, // use access token as password
// ServerProtocol.GmailRestApi);
// oServer.AuthType = ServerAuthType.AuthXOAUTH2;
// 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.Message);
}
}
// client configuration
// 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 string clientID = "570831866161-ha6qpdnke22f7mhf0d50ui22f427drjt.apps.googleusercontent.com";
const string clientSecret = "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";
const string scope = "openid%20profile%20email%20https://mail.google.com";
const string authUri = "https://accounts.google.com/o/oauth2/v2/auth";
const string tokenUri = "https://www.googleapis.com/oauth2/v4/token";
static int GetRandomUnusedPort()
{
var listener = new TcpListener(IPAddress.Loopback, 0);
listener.Start();
var port = ((IPEndPoint)listener.LocalEndpoint).Port;
listener.Stop();
return port;
}
async void DoOauthAndRetrieveEmail()
{
// Creates a redirect URI using an available port on the loopback address.
string redirectUri = string.Format("http://127.0.0.1:{0}/", GetRandomUnusedPort());
Console.WriteLine("redirect URI: " + redirectUri);
// Creates an HttpListener to listen for requests on that redirect URI.
var http = new HttpListener();
http.Prefixes.Add(redirectUri);
Console.WriteLine("Listening ...");
http.Start();
// Creates the OAuth 2.0 authorization request.
string authorizationRequest = string.Format("{0}?response_type=code&scope={1}&redirect_uri={2}&client_id={3}",
authUri,
scope,
Uri.EscapeDataString(redirectUri),
clientID
);
// Opens request in the browser.
System.Diagnostics.Process.Start(authorizationRequest);
// Waits for the OAuth authorization response.
var context = await http.GetContextAsync();
// Brings the Console to Focus.
BringConsoleToFront();
// Sends an HTTP response to the browser.
var response = context.Response;
string responseString = string.Format("<html><head></head><body>Please return to the app and close current window.</body></html>");
var buffer = Encoding.UTF8.GetBytes(responseString);
response.ContentLength64 = buffer.Length;
var responseOutput = response.OutputStream;
Task responseTask = responseOutput.WriteAsync(buffer, 0, buffer.Length).ContinueWith((task) =>
{
responseOutput.Close();
http.Stop();
Console.WriteLine("HTTP server stopped.");
});
// Checks for errors.
if (context.Request.QueryString.Get("error") != null)
{
Console.WriteLine(string.Format("OAuth authorization error: {0}.", context.Request.QueryString.Get("error")));
return;
}
if (context.Request.QueryString.Get("code") == null)
{
Console.WriteLine("Malformed authorization response. " + context.Request.QueryString);
return;
}
// extracts the code
var code = context.Request.QueryString.Get("code");
Console.WriteLine("Authorization code: " + code);
string responseText = await RequestAccessToken(code, redirectUri);
Console.WriteLine(responseText);
OAuthResponseParser parser = new OAuthResponseParser();
parser.Load(responseText);
var user = parser.EmailInIdToken;
var accessToken = parser.AccessToken;
Console.WriteLine("User: {0}", user);
Console.WriteLine("AccessToken: {0}", accessToken);
RetrieveMailWithXOAUTH2(user, accessToken);
}
async Task<string> RequestAccessToken(string code, string redirectUri)
{
Console.WriteLine("Exchanging code for tokens...");
// builds the request
string tokenRequestBody = string.Format("code={0}&redirect_uri={1}&client_id={2}&client_secret={3}&grant_type=authorization_code",
code,
Uri.EscapeDataString(redirectUri),
clientID,
clientSecret
);
// sends the request
HttpWebRequest tokenRequest = (HttpWebRequest)WebRequest.Create(tokenUri);
tokenRequest.Method = "POST";
tokenRequest.ContentType = "application/x-www-form-urlencoded";
tokenRequest.Accept = "Accept=text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8";
byte[] _byteVersion = Encoding.ASCII.GetBytes(tokenRequestBody);
tokenRequest.ContentLength = _byteVersion.Length;
Stream stream = tokenRequest.GetRequestStream();
await stream.WriteAsync(_byteVersion, 0, _byteVersion.Length);
stream.Close();
try
{
// gets the response
WebResponse tokenResponse = await tokenRequest.GetResponseAsync();
using (StreamReader reader = new StreamReader(tokenResponse.GetResponseStream()))
{
// reads response body
return await reader.ReadToEndAsync();
}
}
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 = await reader.ReadToEndAsync();
Console.WriteLine(responseText);
}
}
}
throw ex;
}
}
// Hack to bring the Console window to front.
[DllImport("kernel32.dll", ExactSpelling = true)]
public static extern IntPtr GetConsoleWindow();
[DllImport("user32.dll")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool SetForegroundWindow(IntPtr hWnd);
public void BringConsoleToFront()
{
SetForegroundWindow(GetConsoleWindow());
}
}
}
If you use Google OAuth in ASP.NET/ASP MVC application, you should use a ASP.NET page or ASP MVC Controller to
get authorization code instead of HttpListener. You need to add your ASP.NET page or ASP MVC Controller routing path
to Authorized Redirect URIs
in your Google project.
// Please add http://localhost:54098/oauth/token to Authorized redirect URIs in your Google/MS Azure project.
public ActionResult Token(string code)
{
// code parameter is the authorization code returned by Google OAuth server,
// then you can use it to request AccessToken
// just like RequestAccessToken method in previous example
}
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.