Catch up on everthing we announced at this year's Firebase Summit. Learn more

Créer des gestionnaires d'actions d'e-mail personnalisés

Certaines actions de gestion des utilisateurs, telles que la mise à jour de l'adresse e-mail d'un utilisateur et la réinitialisation du mot de passe d'un utilisateur, entraînent l'envoi d'e-mails à l'utilisateur. Ces e-mails contiennent des liens que les destinataires peuvent ouvrir pour terminer ou annuler l'action de gestion des utilisateurs. Par défaut, les e-mails de gestion des utilisateurs renvoient au gestionnaire d'actions par défaut, qui est une page Web hébergée sur une URL dans le domaine d'hébergement Firebase de votre projet.

Vous pouvez à la place créer et héberger un gestionnaire d'action de courrier électronique personnalisé pour effectuer un traitement personnalisé et intégrer le gestionnaire d'action de courrier électronique à votre site Web.

Les actions de gestion des utilisateurs suivantes nécessitent que l'utilisateur termine l'action à l'aide d'un gestionnaire d'actions par e-mail :

  • Réinitialisation des mots de passe
  • Révocation des modifications d'adresse e-mail : lorsque les utilisateurs modifient les adresses e-mail principales de leur compte, Firebase envoie un e-mail à leurs anciennes adresses pour leur permettre d'annuler la modification.
  • Vérification des adresses e-mail

Pour personnaliser le gestionnaire d'actions par e-mail de votre projet Firebase, vous devez créer et héberger une page Web qui utilise le SDK JavaScript Firebase pour vérifier la validité de la demande et terminer la demande. Ensuite, vous devez personnaliser les modèles d'e-mail de votre projet Firebase pour les lier à votre gestionnaire d'actions personnalisé.

Créer la page du gestionnaire d'actions par e-mail

  1. Firebase ajoute plusieurs paramètres de requête à l'URL de votre gestionnaire d'actions lorsqu'il génère des e-mails de gestion des utilisateurs. Par exemple:

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

    Ces paramètres spécifient la tâche de gestion des utilisateurs que l'utilisateur effectue. Votre page de gestionnaire d'actions d'e-mail doit gérer les paramètres de requête suivants :

    Paramètres
    mode

    L'action de gestion des utilisateurs à effectuer. Peut être l'une des valeurs suivantes :

    • resetPassword
    • recoverEmail
    • verifyEmail
    oobCode Un code à usage unique, utilisé pour identifier et vérifier une demande
    clé API La clé API de votre projet Firebase, fournie pour plus de commodité
    continuerUrl Il s'agit d'une URL facultative qui permet de renvoyer l'état à l'application via une URL. Ceci est pertinent pour les modes de réinitialisation de mot de passe et de vérification des e-mails. Lors de l' envoi d' un e - mail e - mail de réinitialisation de mot de passe ou de vérification, un ActionCodeSettings objet doit être spécifié avec une URL continue pour que cela soit disponible. Cela permet à un utilisateur de continuer là où il s'était arrêté après une action par e-mail.
    langue

    Ceci est l'option BCP47 balise de langue représentant les paramètres régionaux de l'utilisateur (par exemple, fr ). Vous pouvez utiliser cette valeur pour fournir des pages de gestionnaire d'action de courrier électronique localisées à vos utilisateurs.

    La localisation peut être définie via la console Firebase ou dynamiquement en appelant l'API cliente correspondante avant de déclencher l'action par e-mail. Par exemple, l' utilisation de JavaScript: firebase.auth().languageCode = 'fr'; .

    Pour une expérience utilisateur cohérente, assurez-vous que la localisation du gestionnaire d'action d'e-mail correspond à celle du modèle d'e-mail.

    L'exemple suivant montre comment vous pouvez gérer les paramètres de requête dans un gestionnaire basé sur un navigateur. (Vous pouvez également implémenter le gestionnaire en tant qu'application Node.js en utilisant une logique similaire.)

    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. Mot de passe de gérer les demandes de remise à zéro par la première vérification du code d'action avec verifyPasswordResetCode ; puis obtenir un nouveau mot de passe de l'utilisateur et le transmettre à confirmPasswordReset . Par exemple:

    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. Poignée adresse e - mail changement révocations par la première vérification du code d'action avec checkActionCode ; puis restaurer l'adresse e - mail de l'utilisateur avec applyActionCode . Par exemple:

    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. Poignée de vérification d'adresse e - mail en appelant applyActionCode . Par exemple:

    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. Hôte quelque part la page, par exemple l' utilisation Firebase d' hébergement .

Ensuite, vous devez configurer votre projet Firebase pour qu'il soit lié à votre gestionnaire d'action par e-mail personnalisé dans ses e-mails de gestion des utilisateurs.

Pour configurer votre projet Firebase afin d'utiliser votre gestionnaire d'actions par e-mail personnalisé :

  1. Ouvrez votre projet dans la console Firebase .
  2. Aller à la page Modèles e - mail dans la section Auth.
  3. Dans l' une des entrées Types de messagerie, cliquez sur l'icône de crayon pour modifier le modèle de courrier électronique.
  4. Cliquez sur Personnaliser URL d'action et spécifiez l'URL de votre gestionnaire d'action e - mail personnalisé.

Une fois l'URL enregistrée, elle sera utilisée par tous les modèles d'e-mail de votre projet Firebase.