郵件服務的 OAuth2 支援 oauth2-support-for-the-mail-service
AEM as a Cloud Service 為其整合的郵件服務提供 OAuth2 支援,以允許組織遵守安全電子郵件要求。
您可以為多個電子郵件提供者設定 OAuth。 以下是設定 AEM 郵件服務以使用 Microsoft® Office 365 Outlook 透過 OAuth2 進行驗證的逐步指示。 可以類似的方式設定其他廠商。
AEM支援Microsoft® 365的兩個OAuth2型傳輸選項:
- SMTP + OAuth2 — 使用SMTP搭配OAuth2驗證的標準路徑。
- Microsoft Graph API — 當您的組織不允許以SMTP為基礎的傳送(例如,在Microsoft® 365中停用全租使用者SMTP驗證時),會透過Microsoft Graph傳送郵件的替代路徑,這會防止使用SMTP和OAuth2。
如需關於 AEM as a Cloud Service 郵件服務的詳細資訊,請參閱傳送電子郵件 。
Microsoft® Outlook microsoft-outlook
-
前往 https://portal.azure.com/ 並登入。
-
在搜尋列中搜尋 Azure Active Directory,然後按一下結果。 或者,您可以直接瀏覽到 https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview
-
按一下「應用程式註冊 > 新註冊」。
-
根據您的要求填寫資訊,然後按一下「註冊」。
-
前往已建立的應用程式,然後選取「API 權限」。
-
為您的應用程式選取以下權限,然後按一下「新增權限」:
note note NOTE 權限設定可能會隨時間演變。 如果未如預期運作,則搭配 Microsoft® 使用。 https://outlook.office.com/SMTP.Sendopenidoffline_accessemailprofile
-
移至「驗證 > 新增平台 > Web」,並且在「重新導向 URL」區段,新增以下 URL - 一個有正斜線,一個沒有正斜線:
http://localhost/http://localhost
-
新增每個 URL 按「設定」,並根據您的要求進行設定.
-
接下來,移至「憑證和密碼」,按一下「新增用戶端密碼」,並按照畫面上的步驟建立密碼。 請務必記下此密碼以備稍後使用.
-
在左側窗格中按「概觀」並複製「應用程式 (用戶端) ID」和「目錄 (租用戶) ID」的值以供稍後使用。
回顧一下,使用以下資訊為 AEM 端的郵件服務設定 OAuth2:
- 驗證 URL,其以租用戶 ID 建構。 它的形式為:
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize - 權杖 URL,其以租用戶 ID 建構。 它的形式為:
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token - 重新整理 URL,其以租用戶 ID 建構。 它的形式為:
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token - 用戶端 ID
- 用戶端密碼
產生重新整理權杖 generating-the-refresh-token
接下來,執行下列動作,產生重新整理權杖,其為後續步驟中 OSGi 設定的一部分:
-
取代
clientID和tenantID後在瀏覽器中開啟如下 URL,並使用特定於您帳戶的值:code language-none https://login.microsoftonline.com/%3ctenantID%3e/oauth2/v2.0/authorize?client_id=%3cclientId%3e&response_type=code&redirect_uri=http://localhost&response_mode=query&scope=https://outlook.office.com/SMTP.Send%20email%20openid%20profile%20offline_access&state=12345` -
詢問時允許權限。
-
該 URL 會重新導向到一個以此格式建構的新位置:
code language-none http://localhost/?code=<code>&state=12345&session_state=4f984c6b-cc1f-47b9-81b2-66522ea83f81#` -
複製上例中
<code>的值。 -
使用以下 cURL 命令取得 refreshToken。 將 tenantID、clientID 和 clientSecret 替換為您帳戶的值和
<code>的值:code language-none curl --location --request POST 'https://login.microsoftonline.com/<tenantId>/oauth2/v2.0/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Cookie: buid=0.ARgAep0nU49DzUGmoP2wnvyIkcQjsx26HEpOnvHS0akqXQgYAAA.AQABAAEAAAD--DLA3VO7QrddgJg7Wevry9XPJSKbGVlPt5NWYxLtTl3K1W0LwHXelrffApUo_K02kFrkvmGm94rfBT94t25Zq4bCd5IM3yFOjWb3V22yDM7-rl112sLzbBQBRCL3QAAgAA; esctx=AQABAAAAAAD--DLA3VO7QrddgJg7Wevr4a8wBjYcNbBXRievdTOd15caaeAsQdXeBAQA3tjVQaxmrOXFGkKaE7HBzsJrzA-ci4RRpor-opoo5gpGLh3pj_iMZuqegQPEb1V5sUVQV8_DUEbBv5YFV2eczS5EAhLBAwAd1mHx6jYOL8LwZNDFvd2-MhVXwPd6iKPigSuBxMogAA; x-ms-gateway-slice=estsfd; stsservicecookie=estsfd; fpc=Auv6lTuyAP1FuOOCfj9w0U_5vR5dAQAAALDXP9gOAAAAwIpkkQEAAACT2T_YDgAAAA' \ --data-urlencode 'client_id=<clientID>' \ --data-urlencode 'scope=https://outlook.office.com/SMTP.Send email openid profile offline_access' \ --data-urlencode 'redirect_uri=http://localhost' \ --data-urlencode 'grant_type=authorization_code' \ --data-urlencode 'client_secret=<clientSecret>' \ --data-urlencode 'code=<code>' -
記下 refreshToken 和 accessToken。
驗證權杖 validating-the-tokens
在 AEM 端繼續設定 OAuth 之前,請確定使用以下程序驗證 accessToken 和 refreshToken:
-
利用以下 curl,使用前一程序產生的 refreshToken 來產生 accessToken,替換
<client_id>、<client_secret>和<refreshToken>的值:code language-none curl --location --request POST 'https://login.microsoftonline.com/<tenetId>/oauth2/v2.0/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Cookie: buid=0.ARgAep0nU49DzUGmoP2wnvyIkcQjsx26HEpOnvHS0akqXQgYAAA.AQABAAEAAAD--DLA3VO7QrddgJg7Wevry9XPJSKbGVlPt5NWYxLtTl3K1W0LwHXelrffApUo_K02kFrkvmGm94rfBT94t25Zq4bCd5IM3yFOjWb3V22yDM7-rl112sLzbBQBRCL3QAAgAA; esctx=AQABAAAAAAD--DLA3VO7QrddgJg7Wevr4a8wBjYcNbBXRievdTOd15caaeAsQdXeBAQA3tjVQaxmrOXFGkKaE7HBzsJrzA-ci4RRpor-opoo5gpGLh3pj_iMZuqegQPEb1V5sUVQV8_DUEbBv5YFV2eczS5EAhLBAwAd1mHx6jYOL8LwZNDFvd2-MhVXwPd6iKPigSuBxMogAA; x-ms-gateway-slice=estsfd; stsservicecookie=estsfd; fpc=Auv6lTuyAP1FuOOCfj9w0U_IezHLAQAAAPeNSdgOAAAA' \ --data-urlencode 'client_id=<client_id>' \ --data-urlencode 'scope=https://outlook.office.com/SMTP.Send email openid profile offline_access' \ --data-urlencode 'redirect_uri=http://localhost' \ --data-urlencode 'grant_type=refresh_token' \ --data-urlencode 'client_secret=<client_secret>' \ --data-urlencode 'refresh_token=<refreshToken>' -
使用 accessToken 傳送郵件,以查看是否正常運作。
與 AEM as a Cloud Service 整合 integration-with-aem-as-a-cloud-service
-
使用以下語法建立一個名為
com.day.cq.mailer.oauth.impl.OAuthConfigurationProviderImpl.cfg.json(在/apps/<my-project>/osgiconfig/config下) 的 OSGI 屬性檔案:code language-none { authUrl: "<Authorization Url>", tokenUrl: "<Token Url>", clientId: "<clientID>", clientSecret: "$[secret:SECRET_SMTP_OAUTH_CLIENT_SECRET]", scopes: [ "scope1", "scope2" ], authCodeRedirectUrl: "http://localhost", refreshUrl: "<Refresh token Url>", refreshToken: "$[secret:SECRET_SMTP_OAUTH_REFRESH_TOKEN]" } -
填寫
authUrl、tokenUrl和refreshURL,並按照上一節中的描述建構它們。 -
將以下範圍新增到設定中:
note note NOTE 範圍可能會隨時間演變。 如果未如預期運作,則搭配 Microsoft® 使用。 https://outlook.office.com/SMTP.Sendopenidoffline_accessemailprofile
-
建立OSGI屬性檔案
called com.day.cq.mailer.DefaultMailService.cfg.json
在/apps/<my-project>/osgiconfig/config底下,使用下列語法。smtp.host和smtp.port值會反映出進階網路設定,如電子郵件服務教學課程中所述。code language-none { "smtp.host": "$[env:AEM_PROXY_HOST;default=proxy.tunnel]", "smtp.user": "<user account that logged into get the oauth tokens>", "smtp.password": "value not used", "smtp.port": 30465, "from.address": "<from address used for sending>", "smtp.ssl": false, "smtp.starttls": true, "smtp.requiretls": true, "debug.email": false, "oauth.flow": true } -
對於 Outlook,
smtp.host設定值為smtp.office365.com -
在執行階段,傳入
refreshToken values和clientSecret金鑰,方法是使用 Cloud Manager 變數 API,或使用 Cloud Manager 來新增變數。 應該定義變數SECRET_SMTP_OAUTH_REFRESH_TOKEN和SECRET_SMTP_OAUTH_CLIENT_SECRET的值。
如果您使用SMTP和OAuth2,郵件仍然無法運作,請參閱疑難排解。
適用於® Outlook的Microsoft Graph API microsoft-graph-api
請依照與Azure Outlook中說明的相同Microsoft App註冊步驟操作,且在步驟6 (API許可權)中會有下列差異。 使用Microsoft Graph Mail.Send委派許可權,而非Outlook SMTP範圍:
https://graph.microsoft.com/Mail.Sendopenidoffline_accessemailprofile
產生重新整理權杖 graph-generating-the-refresh-token
在授權URL和cURL要求中使用Microsoft圖表範圍,按照與SMTP + OAuth2相同的權杖產生步驟進行。
授權URL (將clientID和tenantID取代為您的值):
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize?client_id=<clientId>&response_type=code&redirect_uri=http://localhost&response_mode=query&scope=https://graph.microsoft.com/Mail.Send%20email%20openid%20profile%20offline_access&state=12345
在cURL權杖請求中,將範圍取代為:
--data-urlencode 'scope=https://graph.microsoft.com/Mail.Send email openid profile offline_access'
與 AEM as a Cloud Service 整合 graph-integration-with-aem-as-a-cloud-service
-
使用Microsoft圖表範圍在
/apps/<my-project>/osgiconfig/config下建立名為com.day.cq.mailer.oauth.impl.OAuthConfigurationProviderImpl.cfg.json的OSGI屬性檔案:code language-none { "authUrl": "https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize", "tokenUrl": "https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token", "clientId": "<clientID>", "clientSecret": "$[secret:SECRET_SMTP_OAUTH_CLIENT_SECRET]", "scopes": [ "https://graph.microsoft.com/Mail.Send", "openid", "offline_access", "email", "profile" ], "authCodeRedirectUrl": "http://localhost", "refreshUrl": "https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token", "refreshToken": "$[secret:SECRET_SMTP_OAUTH_REFRESH_TOKEN]" } -
在
/apps/<my-project>/osgiconfig/config下建立OSGI屬性檔案com.day.cq.mailer.DefaultMailService.cfg.json,並將oauth.flow和graph.flow設定為true:code language-none { "smtp.host": "smtp.office365.com", "smtp.user": "<mailbox account used as the sender>", "smtp.password": "value not used", "smtp.port": 587, "from.address": "<from address used for sending>", "smtp.ssl": false, "smtp.starttls": false, "smtp.requiretls": false, "debug.email": false, "oauth.flow": true, "graph.flow": true } -
在執行階段,傳入
refreshToken和clientSecret金鑰,方法是使用 Cloud Manager 變數 API,或使用 Cloud Manager 來新增變數。 應該定義變數SECRET_SMTP_OAUTH_REFRESH_TOKEN和SECRET_SMTP_OAUTH_CLIENT_SECRET的值。
疑難排解 troubleshooting
如果郵件服務無法正常運作,請重新產生refreshToken。 當您使用SMTP和OAuth2時,請使用產生重新整理權杖,或當您使用Microsoft Graph時產生重新整理權杖。 透過Cloud Manager API傳遞新值;部署可能需要幾分鐘的時間。