Skip to main content
GET
E-Mail-Archiv abrufen

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

id
string
required

MailStoreInstance identifier

Response

MailStoreInstance resource

Eine MailStore-Instanz (E-Mail-Archiv) eines Kunden, betrieben auf der MailStore Service Provider Edition (SPE).

id
string
read-only
instanceID
string

Schlüssel der Instanz auf der SPE — dort eindeutig, hier der natürliche Import-Schlüssel.

displayName
string
alias
string
mailStoreGatewayJournal
boolean

SMTP-Journaling über das MailStore Gateway ({@see \App\Domain\Email\Archive\Gateway\MailStoreGatewayManager}).

mailStoreGatewayProxyMailbox
boolean

Proxy-Mailbox-Archivierung über das MailStore Gateway.

gatewayMailboxId
string | null
read-only

ID der verknüpften Gateway-Archiv-Proxy-Mailbox (mbx-<hex32>), falls vorhanden.

createdAt
string<date-time>
read-only
updatedAt
string<date-time>
read-only
terminatedAt
string<date-time> | null
pricePerMailboxInCents
integer

LISTEN-Stückpreis je Benutzerarchiv in Cent (Streichpreis, {@see \App\Domain\Email\Archive\Billing\MailStoreArchivePricing}).

storageLicenseCount
integer

Zusätzlich gebuchte Speicherlizenzen à 25 GB (SKU EL_mailarchive_002).

mailStoreStatus
enum<string>
Available options:
pending,
success,
failed,
running,
stopped
usedLicenseCount
integer
read-only

Aktuell genutzte Benutzerarchive — die abrechnungsrelevante Menge (Staffel-Eingang).

Example:

12

activeUserCount
integer
read-only
Example:

10