Aller au contenu principal

Configurer la vérification par e-mail avec le service Mailgun

Le connecteur officiel Logto pour le service d’e-mail Mailgun.

astuce:

Ce guide suppose que vous avez une compréhension de base des Connecteurs Logto. Pour ceux qui ne sont pas familiers, veuillez vous référer au guide des Connecteurs pour commencer.

Prérequis​

Configuration de base​

  • Remplissez le champ endpoint si vous utilisez un point de terminaison API Mailgun différent, par exemple, la région UE doit être https://api.eu.mailgun.net. La valeur par défaut est https://api.mailgun.net.
  • Remplissez le champ domain avec le domaine que vous avez enregistré dans votre compte Mailgun. Cette valeur se trouve dans la section Domains du tableau de bord Mailgun. Le domaine doit être au format example.com, sans le préfixe https:// ou http://.
  • Remplissez le champ apiKey avec la clé API que vous avez générée dans votre compte Mailgun.
  • Remplissez le champ from avec l’adresse e-mail à partir de laquelle vous souhaitez envoyer les e-mails. Cette adresse doit être enregistrée dans votre compte Mailgun. L’adresse e-mail doit être au format Sender Name <sender@example.com>.

Livraisons​

Objet de configuration​

La section "Livraisons" vous permet de configurer le contenu des e-mails à envoyer dans différents scénarios. Il s’agit d’une carte clé-valeur JSON où la clé est le type d’utilisation et la valeur est un objet contenant la configuration du contenu pour l’e-mail à envoyer.

{
  "<usage-type>": {
    // ...
  }
}

Types d’utilisation​

Les types d’utilisation suivants sont pris en charge :

  • Register : L’e-mail à envoyer lorsqu’un utilisateur s’inscrit.
  • SignIn : L’e-mail à envoyer lorsqu’un utilisateur se connecte.
  • ForgotPassword : L’e-mail à envoyer lorsqu’un utilisateur réinitialise son mot de passe.
  • Generic : L’e-mail à envoyer lorsqu’un utilisateur effectue une action générique, par exemple, tester le connecteur d’e-mail.
remarque:

Si le type d’utilisation n’est pas spécifié dans la configuration des livraisons, l’e-mail générique sera envoyé. Si l’e-mail générique n’est pas spécifié, le connecteur retournera une erreur.

Configuration du contenu​

Le connecteur prend en charge à la fois le contenu HTML direct et le modèle Mailgun. Vous pouvez utiliser l’un ou l’autre pour chaque type d’utilisation.

Dans le sujet et le contenu, vous pouvez utiliser l’espace réservé {{code}} pour insérer le code de vérification.

Pour utiliser un contenu HTML direct, remplissez les champs suivants :

  • subject : Le sujet de l’e-mail à envoyer.
  • replyTo : L’adresse e-mail à utiliser comme adresse de réponse.
  • html : (Obligatoire) Le contenu HTML de l’e-mail à envoyer.
  • text : La version texte brut de l’e-mail à envoyer.

Pour utiliser un modèle Mailgun, remplissez les champs suivants :

  • subject : Le sujet de l’e-mail à envoyer.
  • replyTo : L’adresse e-mail à utiliser comme adresse de réponse.
  • template : (Obligatoire) Le nom du modèle Mailgun à utiliser.
  • variables : Les variables à transmettre au modèle Mailgun. Doit être une carte clé-valeur JSON car elle sera convertie en chaîne avant l’envoi à Mailgun. Notez qu’il n’est pas nécessaire d’inclure la variable code car elle sera ajoutée automatiquement par le connecteur.

Exemple​

Voici un exemple de configuration des livraisons :

{
  "Register": {
    "subject": "{{code}} est votre code de vérification",
    "replyTo": "Foo <foo@bar.com>",
    "html": "<h1>Bienvenue sur Logto</h1><p>Votre code de vérification est {{code}}.</p>",
    "text": "Bienvenue sur Logto. Votre code de vérification est {{code}}."
  },
  "SignIn": {
    "subject": "Bon retour sur Logto",
    "replyTo": "Foo <foo@bar.com>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

Tester le connecteur d’e-mail Mailgun​

Vous pouvez saisir une adresse e-mail et cliquer sur "Envoyer" pour vérifier si les paramètres fonctionnent avant "Enregistrer et terminer".

C’est tout. N’oubliez pas d’activer le connecteur dans l’inscription et la connexion.