Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

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

Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

Bir kullanıcının e-posta adresini güncelleme ve bir kullanıcının parolasını sıfırlama gibi bazı kullanıcı yönetimi eylemleri, kullanıcıya e-posta gönderilmesine neden olur. 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 Barındırma alanındaki bir URL'de barındırılan bir web sayfası olan varsayılan eylem işleyicisine bağlanır.

Bunun yerine, özel işleme yapmak ve e-posta eylemi işleyicisini web sitenizle entegre etmek için özel bir e-posta eylemi 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 izin veren bir e-posta gönderir
  • E-posta adreslerini doğrulama

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

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

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

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

    Bu parametreler, kullanıcının tamamlamakta olduğu 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 bir kod
    APIAnahtarı Firebase projenizin API anahtarı, kolaylık sağlamak için sağlanmıştır
    devamUrl Bu, durumu bir URL aracılığıyla uygulamaya geri aktarmanın bir yolunu sağlayan isteğe bağlı bir URL'dir. Bu, parola 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ılabilir olması için bir ActionCodeSettings nesnesinin bir devam URL'si ile belirtilmesi gerekir. Bu, kullanıcının bir e-posta işleminden sonra kaldığı yerden devam etmesini mümkün kılar.
    dil

    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 eylemi işleyici sayfaları sağlamak için kullanabilirsiniz.

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

    Tutarlı bir kullanıcı deneyimi için, e-posta eylemi işleyici yerelleştirmesinin e-posta şablonununkiyle 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. (Benzer mantığı kullanarak işleyiciyi bir Node.js uygulaması olarak da uygulayabilirsiniz.)

    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. Parola sıfırlama isteklerini, önce eylem kodunu doğrulamaPasswordResetCode ile verifyPasswordResetCode gerçekleştirin; daha sonra kullanıcıdan yeni bir şifre alın ve bunu confirmPasswordReset . Örneğin:

    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. Önce eylem kodunu checkActionCode ile doğrulayarak e-posta adresi değişikliği iptallerini işleyin; ardından applicationActionCode ile kullanıcının e-posta adresini geri applyActionCode . Örneğin:

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

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

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

Firebase projenizi özel e-posta eylemi 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 eylemi işleyicinizin URL'sini belirtin.

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