建立自訂電子郵件動作處理常式

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

某些使用者管理動作 (例如更新使用者的電子郵件地址和重設使用者密碼) 會導致系統傳送電子郵件給使用者。這些電子郵件包含連結，收件者可以開啟這些連結來完成或取消使用者管理動作。根據預設，使用者管理電子郵件會連結至預設動作處理常式，這是一個在專案 Firebase 託管服務網域中網址託管的網頁。

您可以改為建立並代管自訂電子郵件動作處理常式，以便執行自訂處理作業，並將電子郵件動作處理常式與網站整合。

下列使用者管理動作要求使用者使用電子郵件動作處理常式完成動作：

• 重設密碼
• 撤銷電子郵件地址變更：當使用者變更帳戶的主要電子郵件地址時，Firebase 會傳送電子郵件至舊電子郵件地址，方便使用者撤銷變更
• 驗證電子郵件地址

如要自訂 Firebase 專案的電子郵件動作處理常式，您必須建立並代管使用 Firebase JavaScript SDK 的網頁，以便驗證要求的有效性並完成要求。接著，您必須自訂 Firebase 專案的電子郵件範本，以連結至自訂動作處理常式。

建立電子郵件動作處理常式頁面

1. Firebase 產生使用者管理電子郵件時，會在動作處理常式網址中加入多個查詢參數。例如：

   https://example.com/usermgmt?mode=resetPassword&oobCode=ABC123&apiKey=AIzaSy...&lang=fr

   這些參數會指定使用者要完成的使用者管理工作。電子郵件動作處理程序頁面必須處理下列查詢參數：

   參數
   模式	要完成的使用者管理動作。可為下列其中一個值： resetPassword recoverEmail verifyEmail
   oobCode	一次性驗證碼，用於識別及驗證要求
   apiKey	Firebase 專案的 API 金鑰 (方便起見提供)
   continueUrl	這是選用的網址，可透過網址將狀態傳回應用程式。這與密碼重設和電子郵件驗證模式相關。傳送密碼重設電子郵件或驗證電子郵件時，您必須使用繼續網址指定 ActionCodeSettings 物件，才能使用這項功能。這樣一來，使用者就能在電子郵件動作後繼續進行。
   lang	這是代表使用者語言代碼的選用 BCP47 語言代碼 (例如 fr)。您可以使用這個值為使用者提供本地化的電子郵件動作處理常式頁面。 您可以透過 Firebase 控制台設定本地化，也可以在觸發電子郵件動作之前，透過呼叫對應的用戶端 API 來動態設定本地化。例如，使用 JavaScript：firebase.auth().languageCode = 'fr';。 為提供一致的使用者體驗，請確認電子郵件動作處理常式本地化內容與電子郵件範本相符。

   以下範例說明如何在以瀏覽器為基礎的處理常式中處理查詢參數。(您也可以使用類似的邏輯，將處理程序實作為 Node.js 應用程式)。

   Web

   import { initializeApp } from "firebase/app";
   import { getAuth } from "firebase/auth";
   
   document.addEventListener('DOMContentLoaded', () => {
     // TODO: Implement getParameterByName()
   
     // Get the action to complete.
     const mode = getParameterByName('mode');
     // Get the one-time code from the query parameter.
     const actionCode = getParameterByName('oobCode');
     // (Optional) Get the continue URL from the query parameter if available.
     const continueUrl = getParameterByName('continueUrl');
     // (Optional) Get the language code if available.
     const lang = getParameterByName('lang') || 'en';
   
     // Configure the Firebase SDK.
     // This is the minimum configuration required for the API to be used.
     const config = {
       'apiKey': "YOUR_API_KEY" // Copy this key from the web initialization
                                // snippet found in the Firebase console.
     };
     const app = initializeApp(config);
     const auth = getAuth(app);
   
     // Handle the user management action.
     switch (mode) {
       case 'resetPassword':
         // Display reset password handler and UI.
         handleResetPassword(auth, actionCode, continueUrl, lang);
         break;
       case 'recoverEmail':
         // Display email recovery handler and UI.
         handleRecoverEmail(auth, actionCode, lang);
         break;
       case 'verifyEmail':
         // Display email verification handler and UI.
         handleVerifyEmail(auth, actionCode, continueUrl, lang);
         break;
       default:
         // Error: invalid mode.
     }
   }, false);
   auth_handle_mgmt_query_params.js

   Web

   document.addEventListener('DOMContentLoaded', () => {
     // TODO: Implement getParameterByName()
   
     // Get the action to complete.
     var mode = getParameterByName('mode');
     // Get the one-time code from the query parameter.
     var actionCode = getParameterByName('oobCode');
     // (Optional) Get the continue URL from the query parameter if available.
     var continueUrl = getParameterByName('continueUrl');
     // (Optional) Get the language code if available.
     var lang = getParameterByName('lang') || 'en';
   
     // Configure the Firebase SDK.
     // This is the minimum configuration required for the API to be used.
     var config = {
       'apiKey': "YOU_API_KEY" // Copy this key from the web initialization
                               // snippet found in the Firebase console.
     };
     var app = firebase.initializeApp(config);
     var auth = app.auth();
   
     // Handle the user management action.
     switch (mode) {
       case 'resetPassword':
         // Display reset password handler and UI.
         handleResetPassword(auth, actionCode, continueUrl, lang);
         break;
       case 'recoverEmail':
         // Display email recovery handler and UI.
         handleRecoverEmail(auth, actionCode, lang);
         break;
       case 'verifyEmail':
         // Display email verification handler and UI.
         handleVerifyEmail(auth, actionCode, continueUrl, lang);
         break;
       default:
         // Error: invalid mode.
     }
   }, false);
   custom-email-handler.js

2. 如要處理密碼重設要求，請先使用 verifyPasswordResetCode 驗證動作代碼，然後從使用者取得新密碼，並將其傳遞至 confirmPasswordReset。例如：

   Web

   import { verifyPasswordResetCode, confirmPasswordReset } from "firebase/auth";
   
   function handleResetPassword(auth, actionCode, continueUrl, lang) {
     // Localize the UI to the selected language as determined by the lang
     // parameter.
   
     // Verify the password reset code is valid.
     verifyPasswordResetCode(auth, actionCode).then((email) => {
       const accountEmail = email;
   
       // TODO: Show the reset screen with the user's email and ask the user for
       // the new password.
       const newPassword = "...";
   
       // Save the new password.
       confirmPasswordReset(auth, actionCode, newPassword).then((resp) => {
         // Password reset has been confirmed and new password updated.
   
         // TODO: Display a link back to the app, or sign-in the user directly
         // if the page belongs to the same domain as the app:
         // auth.signInWithEmailAndPassword(accountEmail, newPassword);
   
         // TODO: If a continue URL is available, display a button which on
         // click redirects the user back to the app via continueUrl with
         // additional state determined from that URL's parameters.
       }).catch((error) => {
         // Error occurred during confirmation. The code might have expired or the
         // password is too weak.
       });
     }).catch((error) => {
       // Invalid or expired action code. Ask user to try to reset the password
       // again.
     });
   }
   auth_handle_reset_password.js

   Web

   function handleResetPassword(auth, actionCode, continueUrl, lang) {
     // Localize the UI to the selected language as determined by the lang
     // parameter.
   
     // Verify the password reset code is valid.
     auth.verifyPasswordResetCode(actionCode).then((email) => {
       var accountEmail = email;
   
       // TODO: Show the reset screen with the user's email and ask the user for
       // the new password.
       var newPassword = "...";
   
       // Save the new password.
       auth.confirmPasswordReset(actionCode, newPassword).then((resp) => {
         // Password reset has been confirmed and new password updated.
   
         // TODO: Display a link back to the app, or sign-in the user directly
         // if the page belongs to the same domain as the app:
         // auth.signInWithEmailAndPassword(accountEmail, newPassword);
   
         // TODO: If a continue URL is available, display a button which on
         // click redirects the user back to the app via continueUrl with
         // additional state determined from that URL's parameters.
       }).catch((error) => {
         // Error occurred during confirmation. The code might have expired or the
         // password is too weak.
       });
     }).catch((error) => {
       // Invalid or expired action code. Ask user to try to reset the password
       // again.
     });
   }
   custom-email-handler.js

3. 如要處理電子郵件地址變更撤銷作業，請先使用 checkActionCode 驗證動作代碼，然後使用 applyActionCode 還原使用者的電子郵件地址。例如：

   Web

   import { checkActionCode, applyActionCode, sendPasswordResetEmail } from "firebase/auth";
   
   function handleRecoverEmail(auth, actionCode, lang) {
     // Localize the UI to the selected language as determined by the lang
     // parameter.
     let restoredEmail = null;
     // Confirm the action code is valid.
     checkActionCode(auth, actionCode).then((info) => {
       // Get the restored email address.
       restoredEmail = info['data']['email'];
   
       // Revert to the old email.
       return applyActionCode(auth, actionCode);
     }).then(() => {
       // Account email reverted to restoredEmail
   
       // TODO: Display a confirmation message to the user.
   
       // You might also want to give the user the option to reset their password
       // in case the account was compromised:
       sendPasswordResetEmail(auth, restoredEmail).then(() => {
         // Password reset confirmation sent. Ask user to check their email.
       }).catch((error) => {
         // Error encountered while sending password reset code.
       });
     }).catch((error) => {
       // Invalid code.
     });
   }
   auth_handle_recover_email.js

   Web

   function handleRecoverEmail(auth, actionCode, lang) {
     // Localize the UI to the selected language as determined by the lang
     // parameter.
     var restoredEmail = null;
     // Confirm the action code is valid.
     auth.checkActionCode(actionCode).then((info) => {
       // Get the restored email address.
       restoredEmail = info['data']['email'];
   
       // Revert to the old email.
       return auth.applyActionCode(actionCode);
     }).then(() => {
       // Account email reverted to restoredEmail
   
       // TODO: Display a confirmation message to the user.
   
       // You might also want to give the user the option to reset their password
       // in case the account was compromised:
       auth.sendPasswordResetEmail(restoredEmail).then(() => {
         // Password reset confirmation sent. Ask user to check their email.
       }).catch((error) => {
         // Error encountered while sending password reset code.
       });
     }).catch((error) => {
       // Invalid code.
     });
   }
   custom-email-handler.js

4. 請呼叫 applyActionCode 處理電子郵件地址驗證。例如：

   Web

   function handleVerifyEmail(auth, actionCode, continueUrl, lang) {
     // Localize the UI to the selected language as determined by the lang
     // parameter.
     // Try to apply the email verification code.
     applyActionCode(auth, actionCode).then((resp) => {
       // Email address has been verified.
   
       // TODO: Display a confirmation message to the user.
       // You could also provide the user with a link back to the app.
   
       // TODO: If a continue URL is available, display a button which on
       // click redirects the user back to the app via continueUrl with
       // additional state determined from that URL's parameters.
     }).catch((error) => {
       // Code is invalid or expired. Ask the user to verify their email address
       // again.
     });
   }
   auth_handle_verify_email.js

   Web

   function handleVerifyEmail(auth, actionCode, continueUrl, lang) {
     // Localize the UI to the selected language as determined by the lang
     // parameter.
     // Try to apply the email verification code.
     auth.applyActionCode(actionCode).then((resp) => {
       // Email address has been verified.
   
       // TODO: Display a confirmation message to the user.
       // You could also provide the user with a link back to the app.
   
       // TODO: If a continue URL is available, display a button which on
       // click redirects the user back to the app via continueUrl with
       // additional state determined from that URL's parameters.
     }).catch((error) => {
       // Code is invalid or expired. Ask the user to verify their email address
       // again.
     });
   }
   custom-email-handler.js

5. 將網頁代管在某處，例如使用 Firebase Hosting。

接下來，您必須設定 Firebase 專案，以便在使用者管理電子郵件中連結至自訂電子郵件動作處理常式。

在電子郵件範本中連結至自訂處理程序

如要將 Firebase 專案設為使用自訂電子郵件動作處理常式，請按照下列步驟操作：

1. 在 Firebase 控制台中開啟專案。
2. 前往「Auth」部分的「Email Templates」頁面。
3. 在任何「電子郵件類型」項目中，按一下鉛筆圖示即可編輯電子郵件範本。
4. 按一下「自訂動作網址」，然後指定自訂電子郵件動作處理常式的網址。

儲存網址後，所有 Firebase 專案的電子郵件範本都會使用這個網址。