E-Mail-Verifizierung mit SendGrid Email einrichten

Der offizielle Logto Connector für den SendGrid 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.

Erste Schritte

SendGrid (d. h. Twilio SendGrid) ist eine Kundenkommunikationsplattform für transaktionale und Marketing-E-Mails. Wir können seine E-Mail-Sendefunktion nutzen, um einen Verifizierungscode zu senden.

SendGrid-Konto registrieren

Erstelle ein neues Konto auf der SendGrid-Website. Du kannst diesen Schritt überspringen, wenn du bereits ein Konto hast.

Absender verifizieren

Gehe zur SendGrid-Konsole und melde dich mit deinem SendGrid-Konto an.

Absender geben die Adressen an, von denen unsere E-Mail mit dem Verifizierungscode gesendet wird. Um E-Mails über den SendGrid-Mailserver zu versenden, musst du mindestens einen Absender verifizieren.

Beginne auf der SendGrid-Konsole, gehe im Seitenmenü zu „Settings“ -> „Sender Authentication“.

Domain-Authentifizierung wird empfohlen, ist aber nicht zwingend erforderlich. Du kannst auf „Get started“ in der Karte „Authenticate Your Domain“ klicken und der folgenden Anleitung folgen, um einen Absender mit SendGrid zu verknüpfen und zu verifizieren.

Durch Klicken auf die Schaltfläche „Verify a Single Sender“ im Panel gelangst du zu einem Formular, das einige wichtige Informationen zur Erstellung eines Absenders benötigt. Folge der Anleitung, fülle alle Felder aus und klicke auf „Create“.

Nachdem der einzelne Absender erstellt wurde, sollte eine E-Mail mit einem Verifizierungslink an die E-Mail-Adresse des Absenders gesendet werden. Gehe zu deinem Postfach, finde die Verifizierungs-E-Mail und schließe die Verifizierung des einzelnen Absenders ab, indem du auf den Link in der E-Mail klickst. Du kannst jetzt E-Mails über den SendGrid-Connector mit dem gerade verifizierten Absender versenden.

API-Schlüssel erstellen

Beginne auf der SendGrid-Konsole, gehe im Seitenmenü zu „Settings“ -> „API Keys“.

Klicke oben rechts auf der Seite „API Keys“ auf „Create API Key“. Gib den Namen des API-Schlüssels ein und passe die „API Key Permission“ entsprechend deinem Anwendungsfall an. Ein globaler Full Access oder Restricted Access mit vollem Zugriff auf Mail Send ist erforderlich, bevor du mit diesem API-Schlüssel E-Mails versenden kannst.

Der API-Schlüssel wird dir auf dem Bildschirm angezeigt, sobald du den Create API Key-Prozess abgeschlossen hast. Du solltest diesen API-Schlüssel an einem sicheren Ort speichern, da dies die einzige Gelegenheit ist, ihn zu sehen.

Konfiguriere deinen Connector

Trage das im Abschnitt „API-Schlüssel erstellen“ erstellte API Key in das Feld apiKey ein.

Trage die Felder fromEmail und fromName mit der Absenderadresse und dem Spitznamen des Absenders aus. Die Details des Absenders findest du auf der "Sender Management"-Seite. fromName ist OPTIONAL, du kannst das Ausfüllen also überspringen.

Du kannst mehrere SendGrid-Mail-Connector-Vorlagen für verschiedene Anwendungsfälle hinzufügen. Hier ist ein Beispiel für das Hinzufügen einer einzelnen Vorlage:

• Fülle das Feld subject aus, das als Titel der E-Mails dient.
• Fülle das Feld content mit beliebigen Zeichenfolgen-Inhalten aus. Vergiss nicht, den Platzhalter {{code}} für den zufälligen Verifizierungscode zu belassen.
• Fülle das Feld usageType mit entweder Register, SignIn, ForgotPassword, Generic für verschiedene Anwendungsfälle aus.
• Fülle das Feld type mit entweder text/plain oder text/html für verschiedene Inhaltstypen aus.

Um vollständige Benutzerflüsse zu ermöglichen, sind Vorlagen mit den usageType Register, SignIn, ForgotPassword und Generic erforderlich.

Hier ist ein Beispiel für ein SendGrid-Connector-Template-JSON.

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Ihr Verifizierungscode ist {{code}}. (Register-Vorlage)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Ihr Verifizierungscode ist {{code}}. (Sign-in-Vorlage)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Ihr Verifizierungscode ist {{code}}. (Forgot-password-Vorlage)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Ihr Verifizierungscode ist {{code}}. (Generic-Vorlage)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

SendGrid-E-Mail-Connector testen

Du kannst eine E-Mail-Adresse eingeben und auf „Send“ klicken, um zu prüfen, ob die Einstellungen funktionieren, bevor du auf „Save and Done“ klickst.

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

Konfigurationstypen

Name	Typ
apiKey	string
fromEmail	string
fromName	string (OPTIONAL)
templates	Template[]

Template-Eigenschaften	Typ	Enum-Werte
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
type	enum string	'text/plain' | 'text/html'