Zum Hauptinhalt springen

E-Mails mit Gmail senden

Dieser Leitfaden erklärt, wie Sie die E-Mails von Casdoor von einem Gmail- oder Google Workspace-Postfach ohne App-Passwort senden können. Der Typ Gmail meldet sich bei smtp.gmail.com mit XOAUTH2 an: Casdoor erhält ein OAuth 2.0-Token für den Geltungsbereich https://mail.google.com/ aus einem Google JSON-Schlüssel und meldet sich als das sendende Postfach an.


Lernziele​

  • Erstellen Sie einen Google JSON-Schlüssel, der als Postfach senden darf.
  • Fügen Sie Gmail in Casdoor als E-Mail-Anbieter hinzu und testen Sie ihn.

Voraussetzungen​

  • Eine Google Workspace-Domain und ein Superadministrator oder ein persönliches Gmail-Konto
  • Ein Google Cloud-Projekt
  • Administratorkonto für die Casdoor-Admin-Konsole

Über den JSON-Schlüssel​

Casdoor akzeptiert zwei Arten von Google JSON-Schlüsseln:

Schlüsseltype im JSONSendet alsVerwendung für
Service-Account-Schlüssel mit domänenweiter Delegationservice_accountDie From address, jeder Benutzer der Workspace-DomainGoogle Workspace
Benutzeranmeldeinformationen mit Refresh-Tokenauthorized_userDas Konto, das das Refresh-Token genehmigt hatPersönliches Gmail oder Workspace ohne Delegation

Service-Account-Schlüssel erstellen (Google Workspace)​

  1. Öffnen Sie in der Google Cloud Console Ihr Projekt, gehen Sie zu IAM & Admin > Service accounts und erstellen Sie einen Service Account, z. B. casdoor-mail. Er benötigt keine Rollen.
  2. Öffnen Sie den Service Account. Kopieren Sie auf der Registerkarte Details die Unique ID, die seine Client-ID ist. Klicken Sie auf der Registerkarte Keys auf Add key > Create new key > JSON und bewahren Sie die heruntergeladene Datei auf.
  3. Gehen Sie in der Google Admin Console zu Security > Access and data control > API controls > Manage Domain Wide Delegation und klicken Sie auf Add new. Geben Sie die Client-ID und den Geltungsbereich https://mail.google.com/ ein und klicken Sie auf Authorize.

Die Delegation kann einige Minuten benötigen, bis sie wirksam wird.

Benutzeranmeldeinformationen erstellen (persönliches Gmail)​

  1. Konfigurieren Sie in der Google Cloud Console den OAuth-Zustimmungsbildschirm Ihres Projekts und erstellen Sie eine OAuth-Client-ID vom Typ Desktop app. Laden Sie die JSON-Datei herunter.

  2. Rufen Sie ein Refresh-Token für den Geltungsbereich https://mail.google.com/ ab, indem Sie sich mit dem Konto anmelden, das die E-Mails sendet. Mit der gcloud CLI:

    gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes=https://mail.google.com/
  3. gcloud schreibt die Anmeldeinformationen in application_default_credentials.json in seinen Konfigurationsordner (~/.config/gcloud/ unter Linux und macOS, %APPDATA%\gcloud\ unter Windows). Die Datei enthält "type": "authorized_user", die Client-ID, das Client-Secret und das Refresh-Token.

Solange sich der Zustimmungsbildschirm des Projekts im Status Testing befindet, lässt Google Refresh-Tokens nach 7 Tagen ablaufen. Veröffentlichen Sie die App, um das Token beizubehalten.

Anbieter in Casdoor hinzufügen​

  1. Gehen Sie in der Casdoor-Admin-Konsole zu Identity > Providers und fügen Sie einen Anbieter hinzu.

  2. Setzen Sie Category auf Email und Type auf Gmail. Casdoor füllt Host und Port automatisch aus.

  3. Füllen Sie die Felder aus:

    FeldWert
    Google JSON keyDer Inhalt der JSON-Datei des Service-Account-Schlüssels oder der Benutzeranmeldeinformationen
    From addressDas Postfach, das die E-Mails sendet. Bei einem Service Account meldet sich Casdoor als dieser Benutzer an. Bei Benutzeranmeldeinformationen verwenden Sie die Adresse des Kontos, das das Token genehmigt hat, oder eine seiner Aliasse
    From name(Optional) Der Anzeigename des Absenders
    Hostsmtp.gmail.com
    Port587
    SSL modeAuto, was STARTTLS auf Port 587 verwendet
  4. Schreiben Sie den Email title und den Email content. Siehe Vorlagen.

  5. Speichern Sie den Anbieter.

Enable proxy leitet sowohl die Token-Anfrage als auch die SMTP-Verbindung über den SOCKS5-Proxy von Casdoor. Siehe Proxy.

Ergebnis überprüfen​

  1. Klicken Sie auf Test SMTP Connection. Casdoor holt ein Token und meldet sich bei SMTP als From address an, ohne eine E-Mail zu senden.
  2. Klicken Sie auf Send Testing Email und prüfen Sie, ob die Nachricht im Test Email-Postfach eingeht.

Fügen Sie dann den Provider Ihrer Anwendung hinzu. Siehe Add providers to an application.

Fehlerbehebung​

ErrorCause
the from address of the Gmail email provider must be the mailbox that sends the emailsFrom address ist leer oder keine E-Mail-Adresse
the credentials of the Gmail email provider must be a Google JSON keyGoogle JSON key ist kein gültiges JSON
the credentials of the Gmail email provider must be a "service_account" or "authorized_user" JSON keyDas JSON ist eine andere Art von Schlüssel, z. B. eine OAuth-Client-ID-Datei. Siehe About the JSON key
oauth2: cannot fetch token mit unauthorized_clientDie domänenweite Delegation des Service Accounts fehlt, hat eine andere Client-ID oder verfügt nicht über den Geltungsbereich https://mail.google.com/
oauth2: cannot fetch token with invalid_grantDas Refresh-Token wurde widerrufen oder ist abgelaufen, oder die From address ist kein Benutzer der Workspace-Domain
535 5.7.8 Username and Password not acceptedGmail lehnte das Token ab. Prüfen Sie, ob die From address das Konto ist, für das das Token ausgestellt wurde

Siehe auch​