Zur Dokumentation springen
API

Als eine einzelne Adresse anmelden

Mit einem eigenen Passwort kann sich jemand als eine einzelne Adresse bei OpenEmail anmelden und nur deren Mail lesen und senden.

GET/domains/{id}/addresses/{addressId}/login

Führt jeden der 3 Aufrufe in Ihrem Workspace aus.

GET /domains/{id}/addresses/{addressId}/login

Mit einem eigenen Passwort kann sich jemand als eine einzelne Adresse bei OpenEmail anmelden und nur deren Mail lesen und senden.

Die Anmeldung lesen

Erfordert members:write, wie das Festlegen eines Passworts. login ist null, wenn die Adresse kein Passwort hat.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Antwort
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  }}

Ein auf bestimmte Adressen oder Domains beschränkter Schlüssel wird mit 422 capability_unsupported abgelehnt, und eine App, die für ein Mitglied handelt, erreicht nur die Anmeldung einer Adresse, die dieses Mitglied erreicht.

Das Passwort festlegen

Erfordert members:write. PUT /domains/{id}/addresses/{addressId}/login mit { password } gibt der Adresse ein Passwort oder ersetzt das vorhandene. created sagt, ob die Anmeldung neu ist.

curl
curl -X PUT "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "password": "'"$INBOX_PASSWORD"'" }'
Antwort
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  },  "created": false}

Das Passwort braucht mindestens 8 Zeichen mit einem Kleinbuchstaben, einem Großbuchstaben, einer Ziffer und einem Sonderzeichen, sonst ist der Aufruf ein 422 invalid_parameter auf password. OpenEmail sendet es an niemanden, geben Sie es also selbst weiter.

Ein Passwort zu ersetzen meldet alle ab, die sich mit dem alten angemeldet haben, und entfernt die Weiterleitungsziele, die sie hinzugefügt haben.

Eine Adresse, als die sich bereits ein OpenEmail-Konto anmeldet, wird mit 409 account_exists abgelehnt, und eine ausgeschaltete Adresse mit 409 address_unavailable. Das erste Passwort in einem Workspace, dessen Tarif keinen Teamzugang enthält, wird mit 403 plan_required abgelehnt.

Ein Schlüssel oder eine App muss jeden Scope halten, den eine Anmeldung für eine einzelne Adresse verwenden darf, sonst wird der Aufruf mit 403 insufficient_authority abgelehnt.

Ein OAuth-Zugriffstoken braucht für diesen Aufruf einen Bestätigungscode. Solange die App in den letzten 60 Minuten keinen bestätigt hat, antwortet der Aufruf mit 403 step_up_required und ändert nichts. Ein API-Schlüssel wird nie gefragt. Die Seite Authentifizierung zeigt, wie Sie einen Code anfordern und bestätigen.

Die Anmeldung entfernen

Erfordert members:write. DELETE /domains/{id}/addresses/{addressId}/login entzieht das Passwort und meldet alle ab, die es verwendet haben. Die Adresse und ihre Mail bleiben.

curl
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Antwort
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "deleted": true}

Eine Adresse ohne Passwort ergibt 404.

Referenz