Les applications mobiles doivent parfois interagir avec les utilisateurs et les inciter à effectuer certaines actions en leur envoyant des e-mails.
Les SDK clients Firebase permettent d'envoyer aux utilisateurs des e-mails contenant des liens qu'ils peuvent utiliser pour réinitialiser les mots de passe, valider l'adresse e-mail et se connecter par e-mail. Ces e-mails basés sur des modèles sont envoyés par Google et offrent une personnalisation limitée.
Si vous préférez utiliser vos propres modèles d'e-mails et votre propre service d'envoi d'e-mails, cette page explique comment utiliser le SDK Admin Firebase pour générer par programmation les liens d'action pour les flux ci-dessus, que vous pouvez inclure dans les e-mails envoyés à vos utilisateurs.
Vous bénéficiez ainsi des avantages suivants :
- Personnalisez les modèles d'e-mails. Cela inclut la possibilité d'ajouter de nouveaux styles et une image de marque personnalisée, de modifier le libellé et les logos, de s'adresser aux utilisateurs par leur prénom au lieu de leur nom complet, etc.
- Appliquer différents modèles en fonction du contexte. Par exemple, si l'utilisateur valide son adresse e-mail pour s'abonner à une newsletter, le contexte devra peut-être être fourni dans le contenu de l'e-mail. Un autre exemple est la connexion par lien d'adresse e-mail : dans un scénario, elle peut être déclenchée par le même utilisateur ou en tant qu'invitation par un autre utilisateur. Le contexte devra être inclus dans l'e-mail.
- Localisez les modèles d'e-mails personnalisés.
- Possibilité de générer le lien à partir d'un environnement de serveur sécurisé.
- Possibilité de personnaliser la façon dont le lien doit être ouvert (via une application mobile ou un navigateur) et de transmettre des informations d'état supplémentaires, etc.
- Possibilité de personnaliser le domaine du lien mobile utilisé pour les flux d'applications mobiles lors de la création du lien d'action de l'e-mail.
Initialiser ActionCodeSettings
Avant de pouvoir générer un lien d'action par e-mail, vous devrez peut-être initialiser une instance ActionCodeSettings.
ActionCodeSettings vous permet de transmettre un état supplémentaire via une URL de poursuite accessible une fois que l'utilisateur a cliqué sur le lien dans l'e-mail. Cela permet également à l'utilisateur de revenir à l'application une fois l'action terminée. De plus, vous pouvez spécifier si le lien d'action de l'e-mail doit être géré directement depuis une application mobile lorsqu'elle est installée ou depuis un navigateur.
Pour les liens destinés à être ouverts via une application mobile, vous devrez effectuer certaines tâches pour les détecter depuis votre application mobile. Consultez les instructions sur la façon de configurer les liens mobiles pour les actions par e-mail.
Pour initialiser une instance ActionCodeSettings, fournissez les données suivantes :
| Paramètre | Type | Description |
|---|---|---|
url |
chaîne | Définit le lien (URL d'état/de poursuite) qui a différentes significations selon le contexte :
|
iOS |
({bundleId: string}|undefined) | Définit l'ID de bundle iOS pour aider Firebase Authentication à déterminer s'il doit créer un lien Web uniquement ou un lien mobile qui s'ouvre sur un appareil Apple. |
android |
({packageName: string, installApp:boolean|undefined, minimumVersion: string|undefined}|undefined) | Définit le nom du package Android pour aider Firebase Authentication à déterminer s'il doit créer un lien Web uniquement ou un lien mobile qui s'ouvre sur un appareil Android. |
handleCodeInApp |
(boolean|undefined) | Indique si le lien d'action de l'e-mail sera d'abord ouvert dans une application mobile ou un lien Web. La valeur par défaut est "false" (inactif). Si la valeur est définie sur "true", le lien du code d'action sera envoyé en tant que lien universel ou lien d'application Android, et sera ouvert par l'application si elle est installée. Dans le cas "false", le code sera d'abord envoyé au widget Web, puis, si l'application est installée, l'utilisateur sera redirigé vers celle-ci lorsqu'il cliquera sur "Continuer". |
linkDomain |
(string|undefined) | Lorsque des domaines de liens d'hébergement personnalisés sont définis pour un projet, spécifiez celui à utiliser lorsque le lien doit être ouvert par une application mobile spécifique. Sinon, le domaine par défaut est automatiquement sélectionné (par exemple, PROJECT_ID.firebaseapp.com |
dynamicLinkDomain |
(string|undefined) | Obsolète. Ne spécifiez pas ce paramètre. |
L'exemple suivant montre comment envoyer un lien de validation d'adresse e-mail qui s'ouvrira d'abord dans une application mobile. Le lien profond contiendra la charge utile de l'URL de poursuite https://www.example.com/checkout?cartId=1234. Le domaine de lien Hosting personnalisé utilisé est custom-domain.com, qui doit être configuré pour être utilisé avec Firebase Hosting.
Node.js
const actionCodeSettings = {
// URL you want to redirect back to. The domain (www.example.com) for
// this URL must be whitelisted in the Firebase Console.
url: 'https://www.example.com/checkout?cartId=1234',
// This must be true for email link sign-in.
handleCodeInApp: true,
iOS: {
bundleId: 'com.example.ios',
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12',
},
// The domain must be configured in Firebase Hosting and owned by the project.
linkDomain: 'custom-domain.com',
};
Java
ActionCodeSettings actionCodeSettings = ActionCodeSettings.builder()
.setUrl("https://www.example.com/checkout?cartId=1234")
.setHandleCodeInApp(true)
.setIosBundleId("com.example.ios")
.setAndroidPackageName("com.example.android")
.setAndroidInstallApp(true)
.setAndroidMinimumVersion("12")
.setDynamicLinkDomain("coolapp.page.link")
.build();
Python
action_code_settings = auth.ActionCodeSettings(
url='https://www.example.com/checkout?cartId=1234',
handle_code_in_app=True,
ios_bundle_id='com.example.ios',
android_package_name='com.example.android',
android_install_app=True,
android_minimum_version='12',
dynamic_link_domain='coolapp.page.link',
)
Go
actionCodeSettings := &auth.ActionCodeSettings{
URL: "https://www.example.com/checkout?cartId=1234",
HandleCodeInApp: true,
IOSBundleID: "com.example.ios",
AndroidPackageName: "com.example.android",
AndroidInstallApp: true,
AndroidMinimumVersion: "12",
DynamicLinkDomain: "coolapp.page.link",
}
C#
var actionCodeSettings = new ActionCodeSettings()
{
Url = "https://www.example.com/checkout?cartId=1234",
HandleCodeInApp = true,
IosBundleId = "com.example.ios",
AndroidPackageName = "com.example.android",
AndroidInstallApp = true,
AndroidMinimumVersion = "12",
DynamicLinkDomain = "coolapp.page.link",
};
Pour en savoir plus, consultez Transmettre l'état dans les actions d'e-mail.
Générer un lien de réinitialisation du mot de passe
Pour générer un lien de réinitialisation du mot de passe, indiquez l'adresse e-mail de l'utilisateur existant et un objet ActionCodeSettings facultatif. L'opération sera résolue avec le lien d'action de l'e-mail. L'adresse e-mail utilisée doit appartenir à un utilisateur existant.
Node.js
// Admin SDK API to generate the password reset link.
const userEmail = 'user@example.com';
getAuth()
.generatePasswordResetLink(userEmail, actionCodeSettings)
.then((link) => {
// Construct password reset email template, embed the link and send
// using custom SMTP server.
return sendCustomPasswordResetEmail(userEmail, displayName, link);
})
.catch((error) => {
// Some error occurred.
});
Java
String email = "user@example.com";
try {
String link = FirebaseAuth.getInstance().generatePasswordResetLink(
email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
System.out.println("Error generating email link: " + e.getMessage());
}
Python
email = 'user@example.com'
link = auth.generate_password_reset_link(email, action_code_settings)
# Construct password reset email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)
Go
email := "user@example.com"
link, err := client.PasswordResetLinkWithSettings(ctx, email, actionCodeSettings)
if err != nil {
log.Fatalf("error generating email link: %v\n", err)
}
// Construct password reset template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)
C#
var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GeneratePasswordResetLinkAsync(
email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);
Une fois le lien généré, il peut être inséré dans l'e-mail personnalisé de réinitialisation du mot de passe, puis envoyé à l'utilisateur correspondant à l'aide d'un serveur SMTP personnalisé.
Si vous n'utilisez pas la page de destination de réinitialisation du mot de passe par défaut et que vous créez votre propre gestionnaire personnalisé, consultez Créer des gestionnaires d'actions de messagerie personnalisés.
Générer un lien de validation d'adresse e-mail
Pour générer un lien de validation d'adresse e-mail, fournissez l'adresse e-mail non validée de l'utilisateur existant et un objet ActionCodeSettings facultatif. L'opération sera résolue avec le lien d'action de l'e-mail.
L'adresse e-mail utilisée doit appartenir à un utilisateur existant.
Node.js
// Admin SDK API to generate the email verification link.
const useremail = 'user@example.com';
getAuth()
.generateEmailVerificationLink(useremail, actionCodeSettings)
.then((link) => {
// Construct email verification template, embed the link and send
// using custom SMTP server.
return sendCustomVerificationEmail(useremail, displayName, link);
})
.catch((error) => {
// Some error occurred.
});
Java
String email = "user@example.com";
try {
String link = FirebaseAuth.getInstance().generateEmailVerificationLink(
email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
System.out.println("Error generating email link: " + e.getMessage());
}
Python
email = 'user@example.com'
link = auth.generate_email_verification_link(email, action_code_settings)
# Construct email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)
Go
email := "user@example.com"
link, err := client.EmailVerificationLinkWithSettings(ctx, email, actionCodeSettings)
if err != nil {
log.Fatalf("error generating email link: %v\n", err)
}
// Construct email verification template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)
C#
var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GenerateEmailVerificationLinkAsync(
email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);
Une fois le lien généré, il peut être inséré dans l'e-mail de validation personnalisé, puis envoyé à l'utilisateur correspondant à l'aide d'un serveur SMTP personnalisé.
Si vous n'utilisez pas la page de destination par défaut pour la validation des adresses e-mail et que vous créez votre propre gestionnaire personnalisé, consultez Créer des gestionnaires d'actions de messagerie personnalisés.
Générer un lien de connexion par e-mail
Avant de pouvoir authentifier les utilisateurs avec la connexion par lien e-mail, vous devez activer la connexion par lien e-mail pour votre projet Firebase.
Pour générer un lien de connexion, fournissez l'adresse e-mail de l'utilisateur et un objet ActionCodeSettings. L'objet ActionCodeSettings est requis dans ce cas pour fournir des informations sur l'endroit où rediriger l'utilisateur après qu'il a cliqué sur le lien pour terminer la connexion. L'opération sera résolue avec le lien d'action de l'e-mail.
Contrairement à la réinitialisation du mot de passe et à la validation de l'adresse e-mail, l'adresse e-mail utilisée n'a pas nécessairement besoin d'appartenir à un utilisateur existant, car cette opération peut être utilisée pour inscrire de nouveaux utilisateurs à votre application via un lien d'adresse e-mail.
Node.js
// Admin SDK API to generate the sign in with email link.
const useremail = 'user@example.com';
getAuth()
.generateSignInWithEmailLink(useremail, actionCodeSettings)
.then((link) => {
// Construct sign-in with email link template, embed the link and
// send using custom SMTP server.
return sendSignInEmail(useremail, displayName, link);
})
.catch((error) => {
// Some error occurred.
});
Java
String email = "user@example.com";
try {
String link = FirebaseAuth.getInstance().generateSignInWithEmailLink(
email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
System.out.println("Error generating email link: " + e.getMessage());
}
Python
email = 'user@example.com'
link = auth.generate_sign_in_with_email_link(email, action_code_settings)
# Construct email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)
Go
email := "user@example.com"
link, err := client.EmailSignInLink(ctx, email, actionCodeSettings)
if err != nil {
log.Fatalf("error generating email link: %v\n", err)
}
// Construct sign-in with email link template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)
C#
var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GenerateSignInWithEmailLinkAsync(
email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);
Une fois le lien généré, il peut être inséré dans l'e-mail de connexion personnalisé, puis envoyé à l'utilisateur correspondant à l'aide d'un serveur SMTP personnalisé.
En savoir plus sur l'authentification des utilisateurs avec Firebase à l'aide de liens par e-mail Cela permettra de fournir des informations sur la façon de se connecter une fois que l'utilisateur aura cliqué sur le lien et aura été redirigé vers l'application.