Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Crea gestori di azioni email personalizzati

Alcune azioni di gestione degli utenti, come l'aggiornamento dell'indirizzo e-mail di un utente e la reimpostazione della password di un utente, provocano l'invio di e-mail all'utente. Queste e-mail contengono collegamenti che i destinatari possono aprire per completare o annullare l'azione di gestione degli utenti. Per impostazione predefinita, le e-mail di gestione degli utenti si collegano al gestore di azioni predefinito, che è una pagina Web ospitata in un URL nel dominio Firebase Hosting del progetto.

Puoi invece creare e ospitare un gestore di azioni di posta elettronica personalizzato per eseguire un'elaborazione personalizzata e per integrare il gestore di azioni di posta elettronica con il tuo sito web.

Le seguenti azioni di gestione degli utenti richiedono che l'utente completi l'azione utilizzando un gestore di azioni di posta elettronica:

  • Reimpostazione delle password
  • Revoca delle modifiche agli indirizzi email: quando gli utenti modificano gli indirizzi email principali dei loro account, Firebase invia un'email ai loro vecchi indirizzi che consentono loro di annullare la modifica
  • Verifica degli indirizzi email

Per personalizzare il gestore dell'azione email del tuo progetto Firebase, devi creare e ospitare una pagina web che utilizzi l'SDK JavaScript di Firebase per verificare la validità della richiesta e completare la richiesta. Quindi, devi personalizzare i modelli di email del tuo progetto Firebase per collegarli al tuo gestore di azioni personalizzato.

Crea la pagina del gestore dell'azione email

  1. Firebase aggiunge diversi parametri di query all'URL del gestore di azioni quando genera email di gestione degli utenti. Ad esempio:

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

    Questi parametri specificano l'attività di gestione utente che l'utente sta completando. La pagina del gestore dell'azione email deve gestire i seguenti parametri di query:

    Parametri
    modalità

    L'azione di gestione degli utenti da completare. Può essere uno dei seguenti valori:

    • resetPassword
    • recoverEmail
    • verifyEmail
    oobCode Un codice monouso, utilizzato per identificare e verificare una richiesta
    apiKey La chiave API del tuo progetto Firebase, fornita per comodità
    continueUrl Si tratta di un URL facoltativo che fornisce un modo per ritrasmettere lo stato all'app tramite un URL. Ciò è rilevante per la reimpostazione della password e le modalità di verifica dell'email. Quando si invia un'e-mail di reimpostazione della password o un'e-mail di verifica, è necessario specificare un oggetto ActionCodeSettings con un URL continua affinché sia ​​disponibile. Ciò consente a un utente di continuare dal punto in cui si era interrotto dopo un'azione di posta elettronica.
    lang

    Questo è il tag della lingua BCP47 opzionale che rappresenta le impostazioni internazionali dell'utente (ad esempio, fr ). È possibile utilizzare questo valore per fornire agli utenti pagine del gestore delle azioni di posta elettronica localizzate.

    La localizzazione può essere impostata tramite la console Firebase o dinamicamente chiamando l'API client corrispondente prima di attivare l'azione email. Ad esempio, utilizzando JavaScript: firebase.auth().languageCode = 'fr'; .

    Per un'esperienza utente coerente, assicurati che la localizzazione del gestore dell'azione email corrisponda a quella del modello email.

    L'esempio seguente mostra come gestire i parametri di query in un gestore basato su browser. (Puoi anche implementare il gestore come un'applicazione Node.js utilizzando una logica simile.)

    <script src="https://www.gstatic.com/firebasejs/7.21.0/firebase.js"></script>
    <script>
    document.addEventListener('DOMContentLoaded', function() {
      // 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': <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);
    </script>
    
  2. Gestire le richieste di reimpostazione della password verificando prima il codice dell'azione con verifyPasswordResetCode ; quindi ottenere una nuova password dall'utente e passarla a confirmPasswordReset . Per esempio:

    function handleResetPassword(auth, actionCode, continueUrl, lang) {
      // Localize the UI to the selected language as determined by the lang
      // parameter.
      var accountEmail;
      // Verify the password reset code is valid.
      auth.verifyPasswordResetCode(actionCode).then(function(email) {
        var accountEmail = email;
    
        // TODO: Show the reset screen with the user's email and ask the user for
        // the new password.
    
        // Save the new password.
        auth.confirmPasswordReset(actionCode, newPassword).then(function(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(function(error) {
          // Error occurred during confirmation. The code might have expired or the
          // password is too weak.
        });
      }).catch(function(error) {
        // Invalid or expired action code. Ask user to try to reset the password
        // again.
      });
    }
    
  3. Gestire le revoche della modifica dell'indirizzo e-mail verificando prima il codice dell'azione con checkActionCode ; quindi ripristina l'indirizzo email dell'utente con applyActionCode . Per esempio:

    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(function(info) {
        // Get the restored email address.
        restoredEmail = info['data']['email'];
    
        // Revert to the old email.
        return auth.applyActionCode(actionCode);
      }).then(function() {
        // 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(function() {
          // Password reset confirmation sent. Ask user to check their email.
        }).catch(function(error) {
          // Error encountered while sending password reset code.
        });
      }).catch(function(error) {
        // Invalid code.
      });
    }
    
  4. applyActionCode verifica dell'indirizzo e-mail chiamando applyActionCode . Per esempio:

    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(function(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(function(error) {
        // Code is invalid or expired. Ask the user to verify their email address
        // again.
      });
    }
    
  5. Ospita la pagina da qualche parte, ad esempio utilizza Firebase Hosting .

Successivamente, devi configurare il tuo progetto Firebase in modo che si colleghi al tuo gestore di azioni email personalizzato nelle sue email di gestione degli utenti.

Per configurare il tuo progetto Firebase in modo che utilizzi il tuo gestore di azioni email personalizzato:

  1. Apri il tuo progetto nella console Firebase .
  2. Vai alla pagina Modelli di posta elettronica nella sezione Autenticazione .
  3. In una qualsiasi delle voci Tipi di posta elettronica , fare clic sull'icona della matita per modificare il modello di posta elettronica.
  4. Fare clic su personalizza URL azione e specificare l'URL per il gestore dell'azione email personalizzato.

Dopo aver salvato l'URL, verrà utilizzato da tutti i modelli di email del progetto Firebase.