Zum Hauptinhalt springen

E-Mail-Verifizierung mit Mailgun-E-Mail-Dienst einrichten

Der offizielle Logto-Connector für den Mailgun-E-Mail-Dienst.

tipp

In diesem Leitfaden gehen wir davon aus, dass du grundlegende Kenntnisse über Logto Connectors hast. Falls nicht, schaue dir den Leitfaden Connectors konfigurieren an, um loszulegen.

Voraussetzungen​

Grundkonfiguration​

  • Fülle das endpoint-Feld aus, wenn du einen anderen Mailgun-API-Endpunkt verwendest, zum Beispiel sollte die EU-Region https://api.eu.mailgun.net sein. Der Standardwert ist https://api.mailgun.net.
  • Fülle das domain-Feld mit der Domain aus, die du in deinem Mailgun-Konto registriert hast. Dieser Wert kann im Domains-Abschnitt des Mailgun-Dashboards gefunden werden. Die Domain sollte im Format example.com sein, ohne das https:// oder http:// Präfix.
  • Fülle das apiKey-Feld mit dem API-Schlüssel aus, den du in deinem Mailgun-Konto generiert hast.
  • Fülle das from-Feld mit der E-Mail-Adresse aus, von der du E-Mails senden möchtest. Diese E-Mail-Adresse muss in deinem Mailgun-Konto registriert sein. Die E-Mail-Adresse sollte im Format Sender Name \<[email protected]> sein.

Zustellungen​

Config-Objekt​

Der Abschnitt "Zustellungen" ermöglicht es dir, den Inhalt der E-Mails zu konfigurieren, die in verschiedenen Szenarien gesendet werden sollen. Es ist eine JSON-Schlüssel-Wert-Zuordnung, bei der der Schlüssel der Verwendungstyp ist und der Wert ein Objekt enthält, das die Inhaltskonfiguration für die zu sendende E-Mail enthält.

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

Verwendungstypen​

Die folgenden Verwendungstypen werden unterstützt:

  • Register: Die E-Mail, die gesendet wird, wenn sich ein Benutzer registriert.
  • SignIn: Die E-Mail, die gesendet wird, wenn sich ein Benutzer anmeldet.
  • ForgotPassword: Die E-Mail, die gesendet wird, wenn ein Benutzer sein Passwort zurücksetzt.
  • Generic: Die E-Mail, die gesendet wird, wenn ein Benutzer eine generische Aktion durchführt, zum Beispiel das Testen des E-Mail-Connectors.

Hinweis Wenn der Verwendungstyp nicht in der Zustellungskonfiguration angegeben ist, wird die generische E-Mail gesendet. Wenn die generische E-Mail nicht angegeben ist, gibt der Connector einen Fehler zurück.

Inhaltskonfiguration​

Der Connector unterstützt sowohl direkten HTML-Inhalt als auch Mailgun-Vorlagen. Du kannst eine von ihnen für jeden Verwendungstyp verwenden.

Sowohl im Betreff als auch im Inhalt kannst du den Platzhalter {{code}} verwenden, um den Verifizierungscode einzufügen.

Um direkten HTML-Inhalt zu verwenden, fülle die folgenden Felder aus:

  • subject: Der Betreff der zu sendenden E-Mail.
  • replyTo: Die E-Mail-Adresse, die als Antwortadresse verwendet werden soll.
  • html: (Erforderlich) Der HTML-Inhalt der zu sendenden E-Mail.
  • text: Die Klartextversion der zu sendenden E-Mail.

Um eine Mailgun-Vorlage zu verwenden, fülle die folgenden Felder aus:

  • subject: Der Betreff der zu sendenden E-Mail.
  • replyTo: Die E-Mail-Adresse, die als Antwortadresse verwendet werden soll.
  • template: (Erforderlich) Der Name der zu verwendenden Mailgun-Vorlage.
  • variables: Die Variablen, die an die Mailgun-Vorlage übergeben werden sollen. Sollte eine JSON-Schlüssel-Wert-Zuordnung sein, da sie vor dem Senden an Mailgun in einen String umgewandelt wird. Beachte, dass die code-Variable nicht enthalten sein muss, da sie automatisch vom Connector hinzugefügt wird.

Beispiel​

Das folgende ist ein Beispiel für die Zustellungskonfiguration:

{
  "Register": {
    "subject": "{{code}} ist dein Verifizierungscode",
    "replyTo": "Foo <[email protected]>",
    "html": "<h1>Willkommen bei Logto</h1><p>Dein Verifizierungscode ist {{code}}.</p>",
    "text": "Willkommen bei Logto. Dein Verifizierungscode ist {{code}}."
  },
  "SignIn": {
    "subject": "Willkommen zurück bei Logto",
    "replyTo": "Foo <[email protected]>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

Mailgun-E-Mail-Connector testen​

Du kannst eine E-Mail-Adresse eingeben und auf "Senden" klicken, um zu sehen, ob die Einstellungen funktionieren, bevor du "Speichern und Fertig" auswählst.

Das war's. Vergiss nicht, Connector in der Anmeldeerfahrung aktivieren.