เข้าถึงบริการเมลด้วย OAuth
Contents
[
Hide
]
ได้เพิ่มการสนับสนุน OAuth 2.0 ให้กับ Aspose.Email และสามารถใช้เข้าถึงเซิร์ฟเวอร์ SMTP, POP3, IMAP และ EWS โดยทั่วไป เซิร์ฟเวอร์ทั้งหมดที่สนับสนุนโทเค็น Bearer OAuth 2.0 สามารถใช้กับ Aspose.Email ได้ แต่ไคลเอนต์อีเมลของเราถูกทดสอบกับเซิร์ฟเวอร์อีเมลของ Google และเซิร์ฟเวอร์ Microsoft Office 365 การเข้าถึงเซิร์ฟเวอร์จาก SmtpClient, Pop3Client, ImapClient และ EWSClient ด้วย OAuth สามารถนำไปใช้ได้ 2 วิธี
- ให้โทเค็นการเข้าถึงโดยตรงในคอนสตรัคเตอร์ของไคลเอนต์อีเมล ในกรณีนี้ผู้ใช้ต้องเข้าใจว่าช่วงอายุของโทเค็นการเข้าถึงมีจำกัด เมื่อโทเค็นหมดอายุ ไคลเอนต์อีเมลไม่สามารถใช้เข้าถึงเซิร์ฟเวอร์ได้
- จัดเตรียมการนำเสนอผู้ให้โทเค็นแบบกำหนดเองโดยอิงจาก ITokenProvider อินเทอร์เฟซเข้าสู่คอนสตรัคเตอร์ของไคลเอนต์อีเมล ในกรณีนี้ไคลเอนต์จะตรวจสอบเวลาหมดอายุของโทเค็นและร้องขอ ITokenProvider สำหรับโทเค็นการเข้าถึงใหม่เมื่อโทเค็นก่อนหน้าหมดอายุ ด้วยวิธีนี้ไคลเอนต์จะรีเฟรชโทเค็นเป็นระยะและอาจทำงานกับเซิร์ฟเวอร์ได้ไม่จำกัดเวลา บริการส่วนใหญ่สนับสนุนวิธีง่ายๆ ในการรีเฟรชโทเค็นการเข้าถึง ตัวอย่างเช่น การใช้รีเฟรชโทเค็นในบริการของ Google หรือกระบวนการตรวจสอบสิทธิ์ ROPC ใน Microsoft identity platform สามารถใช้สำหรับการนำผู้ให้โทเค็นไปใช้ได้
กำหนดค่าบัญชีบนเซิร์ฟเวอร์ที่เหมาะสม
บทความต่อไปนี้ช่วยคุณกำหนดค่าบัญชีเพื่อเข้าถึงบริการอีเมล
- สำหรับ Office 365
- สำหรับ Gmail
เข้าถึงบริการอีเมลด้วยโทเค็นการเข้าถึง
ตัวอย่างโค้ดต่อไปนี้แสดงวิธีเชื่อมต่อบริการอีเมลโดยใช้โทเค็นการเข้าถึง
// Connecting to SMTP server
using (SmtpClient client = new SmtpClient(
"smtp.gmail.com",
587,
"user1@gmail.com",
"accessToken",
true,
SecurityOptions.SSLExplicit))
{
}
// Connecting to IMAP server
using (ImapClient client = new ImapClient(
"imap.gmail.com",
993,
"user1@gmail.com",
"accessToken",
true,
SecurityOptions.SSLImplicit))
{
}
// Connecting to POP3 server
using (Pop3Client client = new Pop3Client(
"pop.gmail.com",
995,
"user1@gmail.com",
"accessToken",
true,
SecurityOptions.Auto))
{
}
เข้าถึงบริการอีเมลด้วยผู้ให้โทเค็น
ตัวอย่างโค้ดต่อไปนี้แสดงวิธีเชื่อมต่อบริการอีเมลด้วยผู้ให้โทเค็น
ITokenProvider tokenProvider = TokenProvider.Google.GetInstance(
"ClientId",
"ClientSecret",
"RefreshToken");
// Connecting to SMTP server
using (SmtpClient client = new SmtpClient(
"smtp.gmail.com",
587,
"user1@gmail.com",
tokenProvider,
SecurityOptions.SSLExplicit))
{
}
// Connecting to IMAP server
using (ImapClient client = new ImapClient(
"imap.gmail.com",
993,
"user1@gmail.com",
tokenProvider,
SecurityOptions.SSLImplicit))
{
}
// Connecting to POP3 server
using (Pop3Client client = new Pop3Client(
"pop.gmail.com",
995,
"user1@gmail.com",
tokenProvider,
SecurityOptions.Auto))
{
}
การนำเสนอ Custom ITokenProvider สำหรับ Office 365
คุณสามารถใช้การนำเสนอผู้ให้โทเค็นด้านล่างเพื่อเข้าถึงบริการอีเมลของ Office 365 ได้
using JsonConvert = Newtonsoft.Json.JsonConvert;
using Aspose.Email.Clients;
using Aspose.Email.Common.Utils;
using Aspose.Email.Tests.TestUtils;
using Newtonsoft.Json;
using System;
using System.IO;
using System.Net;
using System.Text;
namespace TestNS
{
/// <summary>
/// Azure resource owner password credential (ROPC) token provider
/// https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth-ropc
/// https://portal.azure.com
/// https://developer.microsoft.com/en-us/graph/graph-explorer/#
/// token parser https://jwt.io
/// </summary>
internal class AzureROPCTokenProvider : ITokenProvider
{
private const string uriFormat = "https://login.microsoftonline.com/{0}/oauth2/v2.0/token";
private const string bodyFormat =
"client_id={0}" +
"&scope={1}" +
"&username={2}" +
"&password={3}" +
"&grant_type={4}";
private readonly string scope;
private const string grant_type = "password";
private readonly object tokenSyncObj = new object();
private OAuthToken token;
private readonly string tenant;
private readonly string clientId;
private readonly string clientSecret;
private readonly string userName;
private readonly string password;
/// <summary>
/// Initializes a new instance of the <see cref="AzureROPCTokenProvider"/> class
/// </summary>
/// <param name="tenant"></param>
/// <param name="clientId"></param>
/// <param name="clientSecret"></param>
/// <param name="scope"></param>
/// <param name="userName"></param>
/// <param name="password"></param>
/// <param name="scopeAr"></param>
public AzureROPCTokenProvider(
string tenant,
string clientId,
string clientSecret,
string userName,
string password,
string[] scopeAr)
{
this.tenant = tenant;
this.clientId = clientId;
this.clientSecret = clientSecret;
this.userName = userName;
this.password = password;
this.scope = string.Join(" ", scopeAr);
}
/// <summary>
/// Gets oAuth access token.
/// </summary>
/// <param name="ignoreExistingToken">
/// If ignoreExistingToken is true, requests new token from a server. Otherwise behaviour is depended on whether token exists or not.
/// If token exists and its expiration date is not expired returns current token, otherwise requests new token from a server.
/// </param>
/// <returns>Returns oAuth access token</returns>
public virtual OAuthToken GetAccessToken(bool ignoreExistingToken)
{
lock (tokenSyncObj)
{
if (this.token != null && !this.token.Expired && !ignoreExistingToken)
return this.token;
token = null;
string uri = string.Format(uriFormat, string.IsNullOrWhiteSpace(tenant) ? "common" : tenant);
HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(uri);
string body = string.Format(bodyFormat,
HttpUtility.UrlEncode(clientId),
HttpUtility.UrlEncode(scope),
HttpUtility.UrlEncode(userName),
HttpUtility.UrlEncode(password),
HttpUtility.UrlEncode(grant_type));
byte[] bytes = Encoding.ASCII.GetBytes(body);
request.Method = "POST";
request.ContentType = "application/x-www-form-urlencoded";
request.ContentLength = bytes.Length;
MemoryStream ms = new MemoryStream(bytes);
using (Stream requestStream = request.GetRequestStream())
requestStream.Write(bytes, 0, bytes.Length);
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
StringBuilder responseText = new StringBuilder();
bytes = new byte[1024];
int read = 0;
using (Stream stream = response.GetResponseStream())
{
while ((read = stream.Read(bytes, 0, bytes.Length)) > 0)
responseText.Append(Encoding.ASCII.GetString(bytes, 0, read));
}
string jsonString = responseText.ToString();
AzureTokenResponse t = JsonConvert.DeserializeObject<AzureTokenResponse>(jsonString);
token = new OAuthToken(
t.access_token,
TokenType.AccessToken,
DateTime.Now.AddSeconds(t.expires_in));
return token;
}
}
/// <summary>
/// Gets oAuth access token.
/// If token exists and its expiration date is not expired returns current token, otherwise requests new token from a server.
/// </summary>
/// <returns>Returns oAuth access token</returns>
public OAuthToken GetAccessToken()
{
return GetAccessToken(false);
}
/// <summary>
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
/// </summary>
public virtual void Dispose()
{
}
}
/// <summary>
/// A success response contains a JSON OAuth 2.0 response with the following parameters.
/// </summary>
public class AzureTokenResponse
{
/// <summary>
/// The requested access token. The calling web service can use this token to authenticate to the receiving web service.
/// </summary>
public string access_token { get; set; }
/// <summary>
/// Indicates the token type value. The only type that Azure AD supports is Bearer For more information about bearer tokens,
/// see The OAuth 2.0 Authorization Framework: Bearer Token Usage (RFC 6750).
/// </summary>
public string token_type { get; set; }
/// <summary>
/// How long the access token is valid (in seconds).
/// </summary>
public int expires_in { get; set; }
/// <summary>
/// How long the access token is valid (in seconds).
/// </summary>
public int ext_expires_in { get; set; }
/// <summary>
/// The time when the access token expires.
/// The date is represented as the number of seconds from 1970-01-01T00:00:00Z UTC until the expiration time.
/// This value is used to determine the lifetime of cached tokens.
/// </summary>
public int expires_on { get; set; }
/// <summary>
/// The App ID URI of the receiving web service.
/// </summary>
public string resource { get; set; }
/// <summary>
/// If an access token was returned, this parameter lists the scopes the access token is valid for.
/// </summary>
public string scope { get; set; }
/// <summary>
/// Issued if the original scope parameter included the openid scope.
/// </summary>
public string id_token { get; set; }
/// <summary>
/// Issued if the original scope parameter included offline_access.
/// </summary>
public string refresh_token { get; set; }
}
}
ตัวอย่างโค้ดต่อไปนี้แสดงวิธีเชื่อมต่อบริการ Office 365 ด้วยผู้ให้โทเค็นแบบกำหนดเอง
ITokenProvider tokenProvider = new AzureROPCTokenProvider(
"Tenant",
"ClientId",
"ClientSecret",
"EMail",
"Password",
scopes);
// Connecting to SMTP server
using (SmtpClient client = new SmtpClient(
"smtp.office365.com",
587,
"Test1@test.onmicrosoft.com",
tokenProvider,
SecurityOptions.SSLExplicit))
{
}
// Connecting to IMAP server
using (ImapClient client = new ImapClient(
"outlook.office365.com",
993,
"Test1@test.onmicrosoft.com",
tokenProvider,
SecurityOptions.SSLImplicit))
{
}
// Connecting to POP3 server
using (Pop3Client client = new Pop3Client(
"outlook.office365.com",
995,
"Test1@test.onmicrosoft.com",
tokenProvider,
SecurityOptions.Auto))
{
}
// Connecting to EWS server
const string mailboxUri = "https://outlook.office365.com/ews/exchange.asmx";
ICredentials credentials = new OAuthNetworkCredential(tokenProvider);
using (IEWSClient ewsClient = EWSClient.GetEWSClient(mailboxUri, credentials))
{
}