Zur Dokumentation springen
Entwicklerv1
CherryMail-Entwicklerdokumentation durchsuchen
Entwickler/Los geht’s
Los geht’s

Authentifizierung und Berechtigungen

Gib jeder Integration genau den Konto- und Postfachzugriff, den sie benötigt.

API-Zugangsdaten

Erstelle in Integrationen einen REST-Schlüssel, der an dein Konto gebunden ist. Sende ihn bei jeder Anfrage im Header Authorization.

Autorisierungsheader
Authorization: Bearer your-cm_rest_-credential

Geheimnisse werden nur einmal angezeigt und als Hashes gespeichert. Bewahre die Schlüssel auf deinem Server auf. Verwende separate Zugangsdaten für verschiedene Anwendungen, damit du jede Integration unabhängig davon rotieren oder widerrufen kannst.

Berechtigungen unabhängig voneinander auswählen

BerechtigungErmöglicht
readKonto- und Ressourcenmetadaten; E-Mail-Lesezugriff für freigegebene E-Mail-Postfächer.
writeÄnderungen an Ressourcen, Entwürfe, Ordner, Markierungen und Nachrichtenorganisation.
sendE-Mail-Versand, Antworten und Weiterleitung.
deleteRessourcen und Nachrichten löschen, vorbehaltlich der Schutzmaßnahmen beim Löschen.
webhookWebhook-Abonnement- und Zustellungsverwaltung für Kontoinhaber und Administratoren.

Berechtigungen sind unabhängig voneinander. write zu haben, bedeutet nicht, dass du auch send oder delete hast. Änderungen an den Kontressourcen erfordern die Rolle „Eigentümer“ oder „Admin“.

Zugriff auf das E-Mail-Postfach autorisieren

Die Mitgliedschaft in einem Konto gewährt allein niemals Zugriff auf E-Mail-Inhalte. Für den Zugriff auf ein E-Mail-Postfach sind sowohl eine aktuelle Berechtigung als auch die Auswahl dieses Postfachs für die Zugangsdaten erforderlich.

  1. Weise den Zugriff mit einem einmalig verwendbaren Bestätigungscode nach, der an das E-Mail-Postfach gesendet wird, oder lass dir vom Kontoinhaber ausdrücklich Zugriff gewähren.
  2. Wähle dieses E-Mail-Postfach aus, wenn du die Zugangsdaten erstellst.
  3. Wähle die Berechtigungen aus, die die Integration für dieses E-Mail-Postfach benötigt.
Die Autorisierung wird bei jedem Vorgang geprüft.
CherryMail prüft erneut die Kontomitgliedschaft, den Zweck der Zugangsdaten, Berechtigungsbereiche, Freigaben und den Ressourceneigentümer. Eine Integration kann keine Ressource aus einem anderen Konto verwenden.

Ablauf, Rotation und Widerruf

Lege beim Ausstellen eines Zugangsmittels ein Ablaufdatum fest. Rotiere die Schlüssel in Integrations und aktualisiere das Geheimnis in deiner Anwendung. Der Widerruf eines Zugangsmittels wird bei nachfolgenden Anfragen sofort wirksam.

Wenn du eine Mitgliedschaft entfernst oder die Freigabe für ein E-Mail-Postfach widerrufst, wird der davon abhängige Zugriff ungültig, einschließlich der Webhook-Zustellungen. MCP verwendet OAuth-Tokens oder einen zweckgebundenen MCP-Schlüssel; mit einem MCP-Zugangsschlüssel kann die Genehmigung nicht über die REST-API umgangen werden.

Als NächstesLimits, Seitennavigation & Fehler