Özel e-posta eylem işleyicileri oluşturma

Kullanıcının e-posta adresini güncelleme ve kullanıcı parolasını sıfırlama gibi bazı kullanıcı yönetimi eylemleri, kullanıcıya e-posta gönderilmesiyle sonuçlanır. Bu e-postalar, alıcıların kullanıcı yönetimi işlemini tamamlamak veya iptal etmek için açabilecekleri bağlantılar içerir. Varsayılan olarak kullanıcı yönetimi e-postaları, projenizin Firebase Hosting alanındaki bir URL'de barındırılan bir web sayfası olan varsayılan eylem işleyiciye bağlanır.

Bunun yerine, özel işleme yapmak ve e-posta eylem işleyicisini web sitenize entegre etmek için özel bir e-posta eylem işleyicisi oluşturabilir ve barındırabilirsiniz.

Aşağıdaki kullanıcı yönetimi eylemleri, kullanıcının eylemi bir e-posta eylem işleyicisi kullanarak tamamlamasını gerektirir:

  • Şifreleri sıfırlama
  • E-posta adresi değişikliklerini iptal etme: Kullanıcılar hesaplarının birincil e-posta adreslerini değiştirdiğinde Firebase, eski adreslerine değişikliği geri almalarına olanak tanıyan bir e-posta gönderir.
  • E-posta adreslerini doğrulama

Firebase projenizin e-posta eylem işleyicisini özelleştirmek için, isteğin geçerliliğini doğrulamak ve isteği tamamlamak amacıyla Firebase JavaScript SDK'sını kullanan bir web sayfası oluşturup barındırmanız gerekir. Ardından, Firebase projenizin e-posta şablonlarını özel eylem işleyicinize bağlanacak şekilde özelleştirmeniz gerekir.

E-posta eylem işleyicisi sayfasını oluşturun

  1. Firebase, kullanıcı yönetimi e-postaları oluştururken eylem işleyici URL'nize çeşitli sorgu parametreleri ekler. Örneğin:

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

    Bu parametreler kullanıcının tamamladığı kullanıcı yönetimi görevini belirtir. E-posta eylem işleyici sayfanız aşağıdaki sorgu parametrelerini işlemelidir:

    Parametreler
    mod

    Tamamlanacak kullanıcı yönetimi eylemi. Aşağıdaki değerlerden biri olabilir:

    • resetPassword
    • recoverEmail
    • verifyEmail
    oobKodu Bir isteği tanımlamak ve doğrulamak için kullanılan tek seferlik kod
    apiKey Kolaylık sağlamak için sağlanan Firebase projenizin API anahtarı
    devam URL'si Bu, durumu bir URL aracılığıyla uygulamaya geri aktarmanın bir yolunu sağlayan isteğe bağlı bir URL'dir. Bu, şifre sıfırlama ve e-posta doğrulama modlarıyla ilgilidir. Parola sıfırlama e-postası veya doğrulama e-postası gönderirken, bunun kullanılabilmesi için bir devam URL'si ile birlikte bir ActionCodeSettings nesnesinin belirtilmesi gerekir. Bu, kullanıcının bir e-posta işleminden sonra kaldığı yerden devam etmesini mümkün kılar.
    uzun

    Bu, kullanıcının yerel ayarını temsil eden isteğe bağlı BCP47 dil etiketidir (örneğin, fr ). Kullanıcılarınıza yerelleştirilmiş e-posta eylem işleyici sayfaları sağlamak için bu değeri kullanabilirsiniz.

    Yerelleştirme, Firebase Konsolu aracılığıyla veya e-posta işlemini tetiklemeden önce ilgili istemci API'si çağrılarak dinamik olarak ayarlanabilir. Örneğin, JavaScript kullanarak: firebase.auth().languageCode = 'fr'; .

    Tutarlı kullanıcı deneyimi için e-posta eylem işleyicisi yerelleştirmesinin e-posta şablonuyla eşleştiğinden emin olun.

    Aşağıdaki örnek, tarayıcı tabanlı bir işleyicide sorgu parametrelerini nasıl işleyebileceğinizi gösterir. (İşleyiciyi benzer mantığı kullanarak bir Node.js uygulaması olarak da uygulayabilirsiniz.)

    Web modular API

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

    Web namespaced API

    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. Parola sıfırlama isteklerini öncelikle eylem kodunu verifyPasswordResetCode ile doğrulayarak işleyin; daha sonra kullanıcıdan yeni bir şifre alın ve bunu confirmPasswordReset iletin. Örneğin:

    Web modular API

    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 namespaced API

    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. E-posta adresi değişikliği iptallerini, önce eylem kodunu checkActionCode ile doğrulayarak gerçekleştirin; daha sonra applyActionCode ile kullanıcının e-posta adresini geri yükleyin. Örneğin:

    Web modular API

    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 namespaced API

    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. applyActionCode öğesini çağırarak e-posta adresi doğrulamasını gerçekleştirin. Örneğin:

    Web modular API

    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 namespaced API

    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. Sayfayı bir yerde barındırın; örneğin Firebase Hosting'i kullanın.

Daha sonra, Firebase projenizi, kullanıcı yönetimi e-postalarındaki özel e-posta eylem işleyicinize bağlanacak şekilde yapılandırmanız gerekir.

Firebase projenizi özel e-posta eylem işleyicinizi kullanacak şekilde yapılandırmak için:

  1. Projenizi Firebase konsolunda açın.
  2. Yetkilendirme bölümündeki E-posta Şablonları sayfasına gidin.
  3. E-posta Türleri girişlerinden herhangi birinde, e-posta şablonunu düzenlemek için kalem simgesini tıklayın.
  4. Eylem URL'sini özelleştir'i tıklayın ve özel e-posta eylem işleyicinizin URL'sini belirtin.

URL'yi kaydettikten sonra Firebase projenizin tüm e-posta şablonları tarafından kullanılacaktır.