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 Verifizierungscode-E-Mails gesendet werden. Um E-Mails über den SendGrid-Mailserver zu senden, musst du mindestens einen Absender verifizieren.

Beginne auf der SendGrid-Konsole, gehe zu "Settings" -> "Sender Authentication" in der Seitenleiste.

Die Domain-Authentifizierung wird empfohlen, ist aber nicht obligatorisch. 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 konzentrierst du dich nun auf ein Formular, das einige wichtige Informationen zur Erstellung eines Absenders erfordert. Folge der Anleitung, fülle alle Felder aus und klicke auf die Schaltfläche "Create".

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

API-Schlüssel erstellen

Beginne auf der SendGrid-Konsole, gehe zu "Settings" -> "API Keys" in der Seitenleiste.

Klicke auf "Create API Key" in der oberen rechten Ecke der API-Schlüssel-Seite. Gib den Namen des API-Schlüssels ein und passe die "API Key Permission" an deinen Anwendungsfall an. Ein globaler Full Access oder Restricted Access mit vollem Zugriff auf Mail Send ist erforderlich, bevor du E-Mails mit diesem API-Schlüssel senden 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.

Deinen Connector konfigurieren

Fülle das apiKey-Feld mit dem im Abschnitt "API-Schlüssel erstellen" erstellten API-Schlüssel aus.

Fülle die Felder fromEmail und fromName mit der From Address und dem Nickname der Absender aus. Du findest die Details des Absenders 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 Fälle hinzufügen. Hier ist ein Beispiel für das Hinzufügen einer einzelnen Vorlage:

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

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

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

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (register template)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (sign-in template)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (forgot-password template)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (generic template)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

SendGrid-E-Mail-Connector testen

Du kannst eine E-Mail-Adresse eingeben und auf "Send" klicken, um zu sehen, ob die Einstellungen funktionieren, bevor du auf "Save and Done" klickst.

Das war's. Vergiss nicht, den Connector in der Anmeldeerfahrung 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'