Skip to main content
POST
Passwort des Gateway-Postfachs zurücksetzen

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Path Parameters

instanceId
string
required

MailStoreInstance identifier

Response

MailStoreGatewayMailbox resource created

Die Gateway-Archiv-Proxy-Mailbox einer Instanz.

instanceId
string
default:""

Identifier ist die Instanz-ID (pro Instanz genau EINE Gateway-Mailbox) — nicht die Mailbox-ID: alle Operationen sind unter /instances/{instanceId}/gateway-mailbox gehängt, also kann API Platform die IRI nur aus instanceId bilden (Muster {@see MailStoreArchiveAccessResource}).

id
string
default:""

Die Gateway-Mailbox-ID (mbx-<hex32>).

Example:

"mbx-9b19a1c2d3e4f5a6b7c8d9e0f1a2b3c4"

name
string
default:""

Name der Mailbox — auf dem Gateway die Domain des Kunden (z. B. planinja.de).

Example:

"planinja.de"

description
string
default:""
Example:

""

status
string
default:""

Active oder Suspended.

Example:

"Active"

archiveAddress
string
default:""

SMTP-Adresse, an die archiviert/journaled wird: {id}@{mailDomain}.

Example:

"mbx-9b19a1c2d3e4f5a6b7c8d9e0f1a2b3c4@mail-archive.kunden.exchange"

mailCount
integer | null

Anzahl archivierter Mails (nur beim GET-Detail befüllt).

Example:

7

password
string | null

Das Gateway-Passwort — wird NUR bei Anlage und Reset zurückgegeben (Gruppe write-result), nie beim GET-Detail. Es ist danach nicht mehr abrufbar.

Example:

"g3n3rat3d-s3cr3t"