Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.

Tạo trình xử lý hành động email tùy chỉnh

Một số hành động quản lý người dùng, chẳng hạn như cập nhật địa chỉ email của người dùng và đặt lại mật khẩu của người dùng, dẫn đến việc gửi email đến người dùng. Những email này chứa các liên kết mà người nhận có thể mở để hoàn thành hoặc hủy bỏ hành động quản lý người dùng. Theo mặc định, các email quản lý người dùng liên kết đến trình xử lý hành động mặc định, là một trang web được lưu trữ tại một URL trong miền Lưu trữ Firebase của dự án của bạn.

Thay vào đó, bạn có thể tạo và lưu trữ trình xử lý hành động email tùy chỉnh để thực hiện xử lý tùy chỉnh và tích hợp trình xử lý hành động email với trang web của bạn.

Các hành động quản lý người dùng sau đây yêu cầu người dùng hoàn thành hành động bằng trình xử lý tác vụ email:

  • Đặt lại mật khẩu
  • Thu hồi các thay đổi địa chỉ email — khi người dùng thay đổi địa chỉ email chính trong tài khoản của họ, Firebase sẽ gửi một email đến địa chỉ cũ của họ để cho phép họ hoàn tác thay đổi
  • Xác minh địa chỉ email

Để tùy chỉnh trình xử lý hành động email của dự án Firebase, bạn phải tạo và lưu trữ một trang web sử dụng SDK JavaScript của Firebase để xác minh tính hợp lệ của yêu cầu và hoàn thành yêu cầu. Sau đó, bạn phải tùy chỉnh các mẫu email của dự án Firebase để liên kết với trình xử lý hành động tùy chỉnh của bạn.

Tạo trang xử lý hành động email

  1. Firebase thêm một số tham số truy vấn vào URL trình xử lý hành động của bạn khi tạo email quản lý người dùng. Ví dụ:

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

    Các tham số này chỉ định nhiệm vụ quản lý người dùng mà người dùng đang hoàn thành. Trang xử lý tác vụ email của bạn phải xử lý các tham số truy vấn sau:

    Thông số
    cách thức

    Hành động quản lý người dùng sẽ được hoàn thành. Có thể là một trong các giá trị sau:

    • resetPassword
    • recoverEmail
    • verifyEmail
    oobCode Mã dùng một lần, được sử dụng để xác định và xác minh một yêu cầu
    Mã API Khóa API của dự án Firebase của bạn, được cung cấp để thuận tiện
    continueUrl Đây là một URL tùy chọn cung cấp một cách để chuyển trạng thái trở lại ứng dụng thông qua một URL. Điều này có liên quan đến các chế độ đặt lại mật khẩu và xác minh email. Khi gửi email đặt lại mật khẩu hoặc email xác minh, đối tượng ActionCodeSettings cần được chỉ định với URL tiếp tục để có thể sử dụng được. Điều này giúp người dùng có thể tiếp tục ngay tại nơi họ đã dừng lại sau một hành động email.
    lang

    Đây là thẻ ngôn ngữ BCP47 tùy chọn đại diện cho ngôn ngữ của người dùng (ví dụ: fr ). Bạn có thể sử dụng giá trị này để cung cấp các trang xử lý hành động email được bản địa hóa cho người dùng của mình.

    Bản địa hóa có thể được đặt thông qua Bảng điều khiển Firebase hoặc động bằng cách gọi API ứng dụng khách tương ứng trước khi kích hoạt tác vụ email. Ví dụ: sử dụng JavaScript: firebase.auth().languageCode = 'fr'; .

    Để có trải nghiệm người dùng nhất quán, hãy đảm bảo bản địa hóa của trình xử lý hành động email khớp với mẫu email.

    Ví dụ sau đây cho thấy cách bạn có thể xử lý các tham số truy vấn trong trình xử lý dựa trên trình duyệt. (Bạn cũng có thể triển khai trình xử lý dưới dạng ứng dụng Node.js bằng cách sử dụng logic tương tự.)

    Web version 9

    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': "YOU_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);

    Web version 8

    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);
  2. Xử lý các yêu cầu đặt lại mật khẩu bằng cách xác minh mã hành động trước với verifyPasswordResetCode ; sau đó lấy mật khẩu mới từ người dùng và chuyển mật khẩu đó để confirmPasswordReset . Ví dụ:

    Web version 9

    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.
      });
    }

    Web version 8

    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.
      });
    }
  3. Xử lý việc thu hồi thay đổi địa chỉ email bằng cách xác minh mã hành động trước với checkActionCode ; sau đó khôi phục địa chỉ email của người dùng với applyActionCode . Ví dụ:

    Web version 9

    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.
      });
    }

    Web version 8

    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.
      });
    }
  4. Xử lý xác minh địa chỉ email bằng cách gọi applyActionCode . Ví dụ:

    Web version 9

    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.
      });
    }

    Web version 8

    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.
      });
    }
  5. Lưu trữ trang ở đâu đó, chẳng hạn như sử dụng Lưu trữ Firebase .

Tiếp theo, bạn phải định cấu hình dự án Firebase của mình để liên kết với trình xử lý hành động email tùy chỉnh của bạn trong các email quản lý người dùng của dự án.

Để định cấu hình dự án Firebase của bạn để sử dụng trình xử lý hành động email tùy chỉnh của bạn:

  1. Mở dự án của bạn trong bảng điều khiển Firebase .
  2. Đi tới trang Mẫu email trong phần Xác thực.
  3. Trong bất kỳ mục nhập Loại email nào, hãy nhấp vào biểu tượng bút chì để chỉnh sửa mẫu email.
  4. Nhấp vào URL hành động tùy chỉnh và chỉ định URL cho trình xử lý hành động email tùy chỉnh của bạn.

Sau khi bạn lưu URL, nó sẽ được sử dụng bởi tất cả các mẫu email của dự án Firebase của bạn.