Zum Hauptinhalt springen

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

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

tipp:

Diese Anleitung setzt voraus, dass du ein grundlegendes Verständnis von Logto Connectors hast. Für diejenigen, die damit nicht vertraut sind, verweisen wir auf die Connectors Anleitung, um loszulegen.

Voraussetzungen​

Grundkonfiguration​

  • Fülle das Feld endpoint 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 Feld domain mit der Domain aus, die du in deinem Mailgun-Konto registriert hast. Dieser Wert ist im Bereich Domains des Mailgun-Dashboards zu finden. Die Domain sollte im Format example.com sein, ohne das Präfix https:// oder http://.
  • Fülle das Feld apiKey mit dem API-Schlüssel aus, den du in deinem Mailgun-Konto generiert hast.
  • Fülle das Feld from mit der E-Mail-Adresse aus, von der du E-Mails versenden möchtest. Diese E-Mail-Adresse muss in deinem Mailgun-Konto registriert sein. Die E-Mail-Adresse sollte im Format Sender Name \<sender@example.com> sein.

Zustellungen​

Konfigurationsobjekt​

Der Abschnitt "Zustellungen" ermöglicht es dir, den Inhalt der E-Mails für verschiedene Szenarien zu konfigurieren. Es handelt sich um eine JSON-Key-Value-Map, wobei der Schlüssel der Verwendungstyp ist und der Wert ein Objekt mit der Inhaltskonfiguration für die zu sendende E-Mail.

{
  "<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 für jeden Verwendungstyp eine der beiden Optionen nutzen.

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 Nur-Text-Version 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. Sollte eine JSON-Key-Value-Map sein, da sie vor dem Senden an Mailgun als String serialisiert wird. Beachte, dass die Variable code nicht enthalten sein muss, da sie automatisch vom Connector hinzugefügt wird.

Beispiel​

Im Folgenden findest du ein Beispiel für die Zustellungskonfiguration:

{
  "Register": {
    "subject": "{{code}} ist dein Verifizierungscode",
    "replyTo": "Foo <foo@bar.com>",
    "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 <foo@bar.com>",
    "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 prüfen, ob die Einstellungen funktionieren, bevor du auf „Speichern und Fertig“ klickst.

Das war's. Vergiss nicht, den Connector für die Anmeldung und Registrierung zu aktivieren.