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

Kullanıcının e-posta adresini güncelleme ve kullanıcının şifresini sıfırlama gibi bazı kullanıcı yönetimi işlemleri, kullanıcıya e-posta gönderilmesine neden olur. Bu e-postalarda, alıcıların kullanıcı yönetimi işlemini tamamlamak veya iptal etmek için açabileceği bağlantılar yer alır. Varsayılan olarak, kullanıcı yönetimi e-postaları varsayılan işlem işleyiciye bağlanır. Bu işleyici, projenizin Firebase Hosting alanındaki bir URL'de barındırılan bir web sayfasıdır.

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

Aşağıdaki kullanıcı yönetimi işlemlerinin tamamlanması için kullanıcının işlemi bir e-posta işlem işleyicisi kullanarak yapması gerekir:

  • Ş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 işlemi işleyicisini özelleştirmek için isteğin geçerliliğini doğrulayan ve isteği tamamlayan bir web sayfası oluşturup barındırmanız gerekir. Bu web sayfasında Firebase JavaScript SDK'sı kullanılır. Ardından, Firebase projenizin e-posta şablonlarını özelleştirerek özel işlem işleyicinize bağlamanız gerekir.

E-posta işlemi işleyici sayfasını oluşturma

  1. Firebase, kullanıcı yönetimi e-postaları oluştururken işlem 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 işlemi işleyici sayfanız aşağıdaki sorgu parametrelerini işlemelidir:

    Parametreler
    mod

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

    • resetPassword
    • recoverEmail
    • verifyEmail
    oobCode İsteğ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ı
    continueUrl Bu, durumu bir URL aracılığıyla uygulamaya geri iletmenin bir yolunu sağlayan isteğe bağlı bir URL'dir. Bu, şifre sıfırlama ve e-posta doğrulama modları için geçerlidir. Şifre sıfırlama e-postası veya doğrulama e-postası gönderirken bu özelliğin kullanılabilmesi için bir ActionCodeSettings nesnesiyle birlikte devam etme URL'si belirtilmesi gerekir. Bu sayede kullanıcılar, e-posta işleminden sonra kaldıkları yerden devam edebilir.
    lang

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

    Yerelleştirme, Firebase konsolu üzerinden veya e-posta işlemi tetiklenmeden önce ilgili istemci API'si çağrılarak dinamik olarak ayarlanabilir. Örneğin, JavaScript kullanıyorsanız: firebase.auth().languageCode = 'fr';.

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

    Aşağıdaki örnekte, tarayıcı tabanlı bir işleyicide sorgu parametrelerini nasıl işleyebileceğiniz gösterilmektedir. (Aynı mantığı kullanarak işleyiciyi bir Node.js uygulaması olarak da uygulayabilirsiniz.)

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

    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);
  2. Şifre sıfırlama isteklerini işlemek için önce işlem kodunu verifyPasswordResetCode ile doğrulayın. Ardından kullanıcıdan yeni bir şifre alın ve confirmPasswordReset'ye iletin. Örneğin:

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

    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.
      });
    }
  3. Öncelikle checkActionCode ile işlem kodunu doğrulayarak e-posta adresi değişikliği iptallerini işleyin, ardından applyActionCode ile kullanıcının e-posta adresini geri yükleyin. Örneğin:

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

    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.
      });
    }
  4. applyActionCode numaralı telefonu arayarak e-posta adresi doğrulamasını gerçekleştirin. Örneğin:

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

    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.
      });
    }
  5. Sayfayı bir yerde barındırın. Örneğin, Firebase Hosting kullanın.

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

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

  1. Firebase konsolunda Güvenlik > Kimlik doğrulama > Şablonlar sekmesine gidin.

  2. E-posta Türleri girişlerinden herhangi birinde e-posta şablonunu düzenlemek için kalem simgesini tıklayın.

  3. İşlem URL'sini özelleştir'i tıklayın ve özel e-posta işlemi işleyicinizin URL'sini belirtin.

URL'yi kaydettikten sonra, Firebase projenizin tüm e-posta şablonlarında kullanılır.