Ga naar inhoud

Mailspace-logs en herstel

Deze endpoints beantwoorden "wat is er met mijn mail gebeurd?" en "kan ik het terugkrijgen?" voor één mailomgeving: het bezorglogboek, het archief met verwijderde berichten die nog terug te zetten zijn, en mailboxen waarvan de mailserver de mail na een definitieve verwijdering nog vasthoudt. Het aanschaffen, resizen en verwijderen van de mailomgeving zelf staat bij Mailspace.

Elk pad op deze pagina begint met /api/mailspace/:mailspace_id/…, waarbij :mailspace_id de GUID van de mailomgeving is uit GET /api/mailspace.

OAuth-scopes: reads vereisen mailspace:read, writes vereisen mailspace:write. Sessie- en API-sleutel-credentials slaan de scopecontroles volledig over (zie OAuth). Een token zonder de vereiste scope wordt geweigerd met 403 {"error":"insufficient_scope", ...} — de OAuth-foutenvelop, niet de {"errors":[...],"code":"..."}-envelop die elke andere fout op deze pagina gebruikt. Zie Scope-handhavingsfouten.

Niets op deze pagina is gepagineerd; page en per_page worden genegeerd. Elke aanroep leest live van de mailserver, dus poll op menselijke tijdschaal. De normale rate limit van de API geldt.

Een leeg resultaat is geen bewijs dat er niets aan de hand is

Bezorgtracing en archivering van verwijderde mail zijn niet op elke omgeving beschikbaar. Waar een van beide ontbreekt, of de mailserver niet bereikbaar is, komen de arrays van het bezorglogboek en de archieflijst terug als een lege lijst, niet als fout, en het antwoord zegt niet waarom. Toon nooit "geen bezorgproblemen" of "niets te herstellen" op basis van alleen een leeg antwoord. Alleen de lijst met herstelbare mailboxen geeft hier 503; zie Leesfouten.

Gedeelde controles

Elk endpoint op deze pagina doorloopt dezelfde controles, in deze volgorde. De eerste die faalt, beantwoordt het verzoek.

Geldt voor Voorwaarde Antwoord
alles mailhosting is niet geconfigureerd op het platform 503 stalwart_unavailable
alles :mailspace_id onbekend, of niet zichtbaar voor je credential 404, lege body
writes gebruiker heeft geen bewerkrecht op de eigen workspace van de mailomgeving 403 not_authorized
alles — reads inbegrepen de mailomgeving is gekoppeld aan een andere mailserver dan nu geconfigureerd is 503 mailspace_server_mismatch
alles mailomgeving staat vast (blokkade door medewerkers of vasthouden wegens onbetaalde factuur) 403 mailspace_suspended
writes mailomgeving is soft-deleted (wacht op verwijdering) 403 pending_delete
alles mailomgeving is nog niet geprovisioneerd 409 not_provisioned
  • Een write is elk verzoek dat geen GET of HEAD is. Dus Een gearchiveerd item terugzetten is een write, en Een gearchiveerd bericht downloaden is een read. Een lid met alleen leesrechten en een mailspace:write-token kan hier alles lezen, maar krijgt 403 not_authorized bij elke restore en delete.
  • Een mailomgeving die op verwijdering wacht, beantwoordt nog reads gedurende de bewaartermijn; elke write wordt geweigerd met 403 pending_delete tot de mailomgeving is teruggezet. Zie Een mailomgeving verwijderen. Een vastgezette mailomgeving (mailspace_suspended) blokkeert reads én writes.
  • Een onbekend of buiten bereik vallend :mailspace_id geeft 404 met een lege body, niet de foutenvelop.

Bezorglogboek

GET /api/mailspace/:mailspace_id/logs

Scope mailspace:read.

Recente mail van deze mailomgeving, in vier aparte arrays: incoming- en outgoing-bezorgtraces, de live uitgaande queue, en issues — bezorgingen die mislukt zijn of nog opnieuw worden geprobeerd.

Dit endpoint heeft geen parameters. Het geeft per dataset hooguit de 100 meest recente entries terug (100 traces, verdeeld over incoming en outgoing; 100 wachtrij-entries; 100 issues). Eén aanroep doet meerdere round trips naar de mailserver, dus poll niet strak.

De vier arrays zijn niet even goed beschikbaar

  • incoming / outgoing komen uit bezorgtracing, dat niet op elke omgeving beschikbaar is. Waar het ontbreekt, zijn beide arrays altijd leeg, hoeveel mail er ook liep.
  • queue is overal beschikbaar.
  • issues combineert permanente fouten (uit de traces) en berichten die nog opnieuw worden geprobeerd (uit de wachtrij); waar tracing ontbreekt verschijnen dus berichten die opnieuw worden geprobeerd nog wel, maar afgeronde bounces niet.

Een gevulde queue met beide tracearrays leeg betekent dat tracing niet beschikbaar is, niet dat er geen mail liep. Er is geen vlag die dat meldt; lees lege tracearrays niet als "geen mailproblemen".

Interne mail staat er twee keer in

Een bericht tussen twee mailboxen in dezelfde mailomgeving staat onder zowel incoming als outgoing, met internal: true zodat je het kunt labelen in plaats van dubbel te tellen.

Teruggegeven params
  • incoming: Array<Object> | traces voor mail die aan de mailboxen van deze mailomgeving is bezorgd
  • outgoing: Array<Object> | traces van bezorgpogingen naar andere mailservers, plus elk intern bericht
  • queue: Array<Object> | berichten die nog in de uitgaande wachtrij staan
  • issues: Array<Object> | permanente fouten (uit de traces) en berichten die nog opnieuw worden geprobeerd (uit de wachtrij)

Elke entry in incoming en outgoing is een trace:

  • id: String | null — de trace-id van de mailserver, zonder controle doorgegeven, dus een trace die de mailserver zonder id vastlegde komt binnen als null. Gebruik dit veld niet zonder controle als sleutel of om de tracearrays te ontdubbelen — de garantie dat het nooit null is geldt voor queue en issues hieronder, en niet hier
  • timestamp: String | ISO 8601, zoals de mailserver het heeft vastgelegd
  • from: String | de envelope-afzender, zoals de mailserver die heeft vastgelegd
  • to: String | ontvangers als komma-gescheiden string, niet als array. Bij mail van een afzender buiten deze mailomgeving worden mede-ontvangers op domeinen die deze mailomgeving niet host verwijderd voordat je het ziet
  • subject: String | null als de mailserver er geen heeft vastgelegd
  • size: Integer | null — bytes
  • direction: String | incoming of outgoing
  • internal: Boolean | true voor mail van mailbox naar mailbox binnen deze mailomgeving (zie hierboven)
  • status: String | afgeleid uit het SMTP-log: delivered, bounced, failed, retrying of sending
  • events: Array<Object> | het SMTP-log, in de volgorde waarin de mailserver het heeft vastgelegd
    • name: String | de naam van de mailserver-event, bijv. delivery.attempt-start
    • timestamp: String | ISO 8601
    • key_values: Array<Object> | de detailvelden van de event, als lijst in plaats van als object omdat dezelfde key legitiem kan terugkomen binnen één event
      • key: String
      • value: String, Integer of Boolean | onbewerkt doorgegeven van de mailserver

Elke entry in queue en issues is een bericht in de wachtrij:

  • id: String | de eigen wachtrij-id van de mailserver bij een wachtrij-entry, en een stabiele kunstmatige trace-<…>-id bij een issue dat uit een trace is afgeleid. Nooit null in deze twee arrays (anders dan de eigen id van een trace).
  • source: String | queue of trace — uit welke dataset de entry komt. Aanwezig op elke entry van queue en issues; de trace-arrays bevatten het veld niet
  • created_at: String | ISO 8601
  • return_path: String | de envelope-afzender. Leeg betekent een null return path (<>): het bericht is een bouncemelding
  • subject: String | null
  • size: Integer | null — bytes
  • flags: Array<String> | vlaggen van de mailserver, bijv. dsnSent zodra er een bouncemelding is verstuurd
  • recipients: Array<Object>
    • address: String
    • status: String | Completed, TemporaryFailure of PermanentFailure; null zolang de ontvanger nog in de wachtrij staat en er niets is geprobeerd
    • retry_due: String | null — ISO 8601, wanneer de volgende poging volgt
    • retry_count: Integer | null
    • error: Object | null wanneer de mailserver geen foutdetails voor die ontvanger heeft gemeld
      • type: String | null — het fouttype van de mailserver
      • response_code: Integer | null — de SMTP-statuscode. Wordt onbewerkt doorgegeven, dus een issue dat uit een trace komt bevat wat het SMTP-log heeft vastgelegd en kan een String teruggeven
      • response_enhanced: String | null — de enhanced status code, bijv. 5.1.1
      • response_hostname: String | null — de server die antwoordde
      • message: String | null — de tekst van de andere server
  • events: Array<Object> | het SMTP-log in dezelfde vorm als bij een trace. Leeg bij een live wachtrij-entry, die nog geen trace heeft; alleen gevuld bij een issue dat uit een trace komt

Leid de status op berichtniveau zelf af

Een bericht in de wachtrij heeft geen status op het hoogste niveau. Leid hem af uit recipients en flags:

  1. een ontvanger op PermanentFailure → bounced als flags dsnSent bevat, anders failed;
  2. anders een ontvanger op TemporaryFailure → retrying;
  3. anders alle ontvangers op Completed → delivered;
  4. anders → sending.

Een issues-entry heeft de wachtrijvorm maar twee mogelijke bronnen

Kijk naar source ("queue" of "trace"; aanwezig op elke entry van queue en issues, niet op de tracearrays).

  • "trace" — een afgeronde bounce of weigering. Die is definitief en bevat het volledige SMTP-log in events. De id is een stabiele kunstmatige trace-<…>-waarde waarop je mag sleutelen. recipients bevat één entry waarvan de address de hele komma-gescheiden ontvangerstring van de trace is, met status PermanentFailure, en retry_due, retry_count en error.type op null. flags is ["dsnSent"] als er een bouncemelding is verstuurd, anders [].
  • "queue" — een echte wachtrij-entry die nog opnieuw wordt geprobeerd, vermeld met alleen zijn falende ontvangers (een subset van de entry onder queue). events is leeg.

De twee bronnen tellen een bericht nooit dubbel.

curl -H "Authorization: Bearer $CLOUDPRESS_TOKEN" \
  -H "X-Auth-Account: $ACCOUNT_ID" \
  https://my.cloudpress.com/api/mailspace/$MAILSPACE_ID/logs

Archief met verwijderde mail

Mail die een gebruiker heeft verwijderd en die de mailserver nog vasthoudt. Een item blijft staan tot zijn archived_until-deadline en wordt dan definitief gewist. De bewaartermijn geldt voor de hele server en kan niet via de API worden aangepast.

Een leeg archief is geen bewijs dat er niets is verwijderd

Gearchiveerde mail opvragen geeft 200 met een lege archived_items-array, zowel als er niets is gearchiveerd als wanneer archivering op de omgeving niet beschikbaar is (elk by-id-endpoint geeft dan 404 unknown_archived_item). Niets in het antwoord maakt het verschil. Een onbereikbare mailserver is anders: die geeft 503.

  • Item-id's zijn opaak. Gebruik de id uit de lijst als :stalwart_id-segment; een id dat niet bij deze mailomgeving hoort, geeft 404 unknown_archived_item.
  • Vertak op code, nooit op errors[0]. Archieffouten bevatten een Engelse zin, welke Accept-Language je ook stuurt, en de formulering kan veranderen.

Gearchiveerde mail opvragen

GET /api/mailspace/:mailspace_id/archived_items

Scope mailspace:read.

Elk terug te zetten verwijderd bericht uit alle mailboxen van de mailomgeving, laatst gearchiveerd eerst. Niet gepagineerd: de lijst is beperkt tot 500 items per mailbox en wat daarboven valt, wordt zonder markering weggelaten.

Teruggegeven params
  • archived_items: Array
    • id: String | de opake item-id — dit is het :stalwart_id-segment voor elk endpoint op id hieronder
    • type: String | de variant van het item. In de praktijk Email; de mailserver kent andere maar schrijft ze nooit
    • status: String | archived, of requestRestore zodra er een terugzetting voor is ingepland. De mailserver laat het veld weg zolang het op zijn standaardwaarde staat, dus het wordt ingevuld als archived
    • subject: String | null
    • from: String | null
    • size: Integer | null — bytes
    • received_at: String | null — ISO 8601, wanneer het bericht origineel aankwam
    • archived_at: String | null — ISO 8601, wanneer het naar het archief is verwijderd
    • archived_until: String | null — ISO 8601, de deadline voor definitieve verwijdering. Serverbrede bewaartermijn, niet per item
    • mailbox_email: String | het adres waaruit het bericht is verwijderd
    • mailbox_id: String | de GUID van die mailbox

De blob- en account-handles van het item op de mailserver worden bewust niet meegegeven: beide zijn globale, ongescope handles, en het bericht zelf komt terug via Een gearchiveerd bericht downloaden.

Fouten
  • 503 archived_items_unavailable | de archiefquery kon niet worden uitgevoerd. Geen clientfout, en dus opnieuw te proberen — zie Leesfouten. Een archief dat op de omgeving niet beschikbaar is, geeft nog steeds de lege 200 die hierboven staat
  • plus de gedeelde controles

Een gearchiveerd item bekijken

GET /api/mailspace/:mailspace_id/archived_items/:stalwart_id

Scope mailspace:read. Eén item, met dezelfde velden als de lijst, onder een archived_item-object.

De body van het bericht komt hier niet terug — gebruik Een gearchiveerd bericht downloaden voor het originele bericht.

Fouten
  • 404 unknown_archived_item | zo'n item bestaat niet, of het hoort niet bij deze mailomgeving
  • 503 archived_item_lookup_unavailable | de eigendomscontrole kon niet worden uitgevoerd, dus het item is niet bevestigd en niet ontkend. Het opnieuw proberen waard, en geen teken dat het item weg is
  • plus de gedeelde controles

Een gearchiveerd item terugzetten

POST /api/mailspace/:mailspace_id/archived_items/:stalwart_id/restore

Scope mailspace:write.

Dit meldt een verzoek, geen afgeronde terugzetting

Het antwoord zegt restore_queued en nooit restored; er is geen voltooiingssignaal om te pollen. Lees ter controle het archief opnieuw: een teruggezet item staat er niet meer in en het bericht keert onder een nieuwe id terug in de mailbox.

Teruggegeven params
  • status: String | altijd "restore_queued"
  • archived_item: Object | de velden van het item, exact als in de lijst

Twee verschillende status-velden

De status op het hoogste niveau beschrijft jouw verzoek (restore_queued). De status binnen archived_item is het eigen veld van het item, zoals het stond toen het item werd opgezocht — dus een eerste terugzetting laat hier archived zien, ook al is het verzoek geaccepteerd, en een tweede op hetzelfde item laat requestRestore zien. Lees het item opnieuw in plaats van dit veld als de uitkomst te lezen.

Fouten
  • 404 unknown_archived_item | zo'n item bestaat niet, of het hoort niet bij deze mailomgeving. Ook wat je krijgt als het item tussen het opzoeken en de terugzetting zelf verdwijnt
  • 422 restore_failed | de mailserver heeft geantwoord en de terugzetting geweigerd. Er is niets in de wachtrij gezet
  • 503 archived_item_lookup_unavailable | de eigendomscontrole kon niet worden uitgevoerd, dus er is niets verstuurd naar de mailserver. Het item is onaangeroerd
  • 503 restore_unconfirmed | onbepaald. De herstelopdracht is verstuurd en de uitkomst is onbekend, dus de terugzetting staat mogelijk al in de wachtrij
  • plus de gedeelde controles, inclusief 403 not_authorized en 403 pending_delete

Twee 503-codes die het tegenovergestelde betekenen

archived_item_lookup_unavailable betekent dat er niets is geprobeerd. restore_unconfirmed betekent dat de opdracht is verstuurd en de uitkomst onbekend is, dus lees het item of het archief opnieuw in voordat je het opnieuw probeert. Een verdwenen item geeft 404 unknown_archived_item; restore_failed is alleen voor een echte weigering van de mailserver.

Een gearchiveerd bericht downloaden

GET /api/mailspace/:mailspace_id/archived_items/:stalwart_id/download

Scope mailspace:read.

Dit endpoint geeft bij succes geen JSON terug

Een geslaagde download is het originele RFC822-bericht als ruwe bytes (Content-Type: message/rfc822, bijlage-disposition). Fouten zijn nog steeds JSON in de gebruikelijke foutenvelop, dus controleer de status voordat je de body als bericht behandelt.

De bestandsnaam van de bijlage komt van het opgeslagen onderwerp van het bericht, waarbij tekens anders dan letters, cijfers, underscores, spaties, streepjes en punten door _ worden vervangen, ingekort tot 80 tekens, plus .eml. Een bericht zonder bruikbaar onderwerp krijgt de item-id als naam.

curl -o message.eml \
  -H "Authorization: Bearer $CLOUDPRESS_TOKEN" \
  -H "X-Auth-Account: $ACCOUNT_ID" \
  https://my.cloudpress.com/api/mailspace/$MAILSPACE_ID/archived_items/$ITEM_ID/download
Fouten
  • 404 unknown_archived_item | zo'n item bestaat niet, of het hoort niet bij deze mailomgeving
  • 404 / 503 download_unavailable | het bericht kon niet worden geleverd, en de status is het verschil: 404 wanneer de mailserver heeft geantwoord dat het opgeslagen bericht weg is (definitief — stop), 503 bij elke andere leesfout (het bericht kan er nog zijn — probeer het opnieuw). Eén code, omdat het één feit over één resource is; de status zegt wat je nu moet doen
  • 503 archived_item_lookup_unavailable | de eigendomscontrole kon niet worden uitgevoerd
  • plus de gedeelde controles

Een gearchiveerd item verwijderen

DELETE /api/mailspace/:mailspace_id/archived_items/:stalwart_id

Scope mailspace:write.

Onomkeerbaar

Dit wist het gearchiveerde bericht vóór de bewaardeadline. Daarna is niets meer te herstellen en er is geen bevestigingsparameter.

Een item dat al weg is, geeft 404 unknown_archived_item, dus een herhaalde DELETE is niet idempotent.

Teruggegeven params
  • deleted: Boolean | altijd true
  • id: String | het item dat is gewist
  • subject: String | null — vastgelegd vóór de wissing
Fouten
  • 404 unknown_archived_item | zo'n item bestaat niet, of het hoort niet bij deze mailomgeving. Ook wat je krijgt als het item tussen het opzoeken en de wissing zelf verdwijnt — zie de note hierboven
  • 422 delete_failed | de mailserver heeft geantwoord en de wissing geweigerd. Er is niets vernietigd
  • 503 archived_item_lookup_unavailable | de eigendomscontrole kon niet worden uitgevoerd, dus er is niets verstuurd. Het item is onaangeroerd
  • 503 delete_unconfirmed | onbepaald, en deze wissing is onomkeerbaar: het item kan al weg zijn
  • plus de gedeelde controles

Lees bij delete_unconfirmed eerst het item terug

Het wissen kan al zijn gebeurd en is niet terug te draaien. Doe een GET op het item: een 404 betekent dat het is gelukt. Behandel dit niet als "het verwijderen is mislukt".


Definitief verwijderde mailboxen

Mailboxen die definitief zijn verwijderd maar waarvan de mailserver de mail nog vasthoudt tot het einde van de bewaartermijn. Tot dan kan de mailbox met zijn oorspronkelijke id worden teruggehaald. Ze maken geen deel uit van de mailboxlijst van de mailomgeving en hebben daarom een eigen endpoint.

Herstelbare mailboxen opvragen

GET /api/mailspace/:mailspace_id/purged_mailboxes

Scope mailspace:read.

De definitief verwijderde mailboxen die nog hersteld kunnen worden, gesorteerd op recoverable_until zodat degene die bijna verloren gaat eerst komt. Niet gepagineerd. Een record dat de mailserver niet meer vasthoudt, wordt weggelaten.

Een genoemde mailbox is echt; een lege lijst is geen bewijs dat de mail weg is

Een mailserver die niet bevraagd kan worden, geeft 503 purged_mailboxes_unavailable, geen lege 200. Maar op een drukke server kan de lijst nog steeds stilletjes een herstelbare mailbox weglaten. Lees een lege lijst als "niets gevonden" en gooi nooit je eigen laatste record van een mailbox weg op grond daarvan; bewaar het tot de recoverable_until van het record is verstreken.

Teruggegeven params
  • purged_mailboxes: Array
    • id: String | de GUID van het record — dit is het :guid-segment dat Een definitief verwijderde mailbox herstellen neemt
    • email: String | het adres dat zou terugkomen
    • display_name: String | null
    • purged_at: DateTime | wanneer CloudPress de mailbox definitief verwijderde
    • recoverable_until: DateTime | de eigen wisdeadline van de mailserver, bij het verwijderen gespiegeld — nooit een lokaal berekende termijn
    • days_remaining: Integer | hele dagen die resteren, met 0 als ondergrens

De opgeslagen quota, aliassen, lidmaatschappen en de account-id op de mailserver worden bewust niet meegegeven: dat is input voor het herstel, geen beschrijving van de verwijderde mailbox.

Fouten
  • 503 purged_mailboxes_unavailable | de mailserver kon niet gevraagd worden welke accounts hij nog vasthoudt, dus de lijst kan niet worden beantwoord. Opnieuw te proberen, en bewust geen lege 200 — een client zou die lezen als "niets te herstellen"
  • plus de gedeelde controles

Een definitief verwijderde mailbox herstellen

PATCH /api/mailspace/:mailspace_id/purged_mailboxes/:guid

Scope mailspace:write.

Annuleert het openstaande wissen en bouwt de mailbox opnieuw op met zijn weergavenaam, opgeslagen quotum en aliassen. Het quotum wordt naar beneden bijgesteld als het plan er geen ruimte meer voor heeft, dus de mailbox kan iets kleiner terugkomen.

password is verplicht

Een herstelde mailbox komt zonder inloggegevens terug, dus je moet er een instellen. Een ontbrekend of leeg password wordt geweigerd met 400 password_blank voordat er iets wordt aangeraakt.

Params
  • password: String (verplicht) | het wachtwoord waarmee de herstelde mailbox terugkomt. Een lege of ontbrekende waarde geeft 400 password_blank

Een 200 bewijst niet dat alles terug is. Lidmaatschappen van groepen en mailinglijsten worden opnieuw toegepast waar de groep of lijst nog bestaat, en sommige aliassen kunnen wegvallen, dus lees de mailbox terug en voeg opnieuw toe wat ontbreekt. Het record wordt bij succes verbruikt, dus een tweede PATCH van dezelfde :guid geeft 404 unknown_purged_mailbox.

Teruggegeven params
  • mailbox: Object | dezelfde vorm die de endpoints voor het verwijderen en herstellen van een mailbox teruggeven
    • id: String | de GUID van de herstelde mailbox
    • email: String
    • status: String | active
    • scheduled_deletion_at: DateTime | null
    • days_until_deletion: Integer | null

Een mailbox kan onherstelbaar worden terwijl hij nog in de lijst staat

Vertak op de status:

  • 409 not_recoverable — definitief, probeer niet opnieuw. De hersteltermijn is verstreken, of de mailserver bevestigde dat hij het account niet meer vasthoudt (het record wordt dan verwijderd, dus een nieuwe poging geeft 404 unknown_purged_mailbox).
  • 422 restore_failed — de mailserver weigerde, of een latere stap faalde. Opnieuw proberen kan werken. Oorzaken zijn onder meer dat het adres weer in gebruik is door een nieuwe mailbox (verwijder of hernoem die eerst) en dat de mailboxlimiet van het plan vol is (verwijder een andere mailbox of upgrade eerst).
  • 503 restore_unavailable — de controle kon niet worden uitgevoerd en er is niets geprobeerd. Probeer opnieuw.

Herstel in lijstvolgorde, wat het eerst verloopt eerst.

curl -X PATCH \
  -H "Authorization: Bearer $CLOUDPRESS_TOKEN" \
  -H "X-Auth-Account: $ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{"password": "a-strong-password"}' \
  https://my.cloudpress.com/api/mailspace/$MAILSPACE_ID/purged_mailboxes/$PURGED_ID
Fouten
  • 404 unknown_purged_mailbox | zo'n record bestaat niet in deze mailomgeving, of het is al verbruikt
  • 409 not_recoverable | definitief — niet opnieuw proberen. Of het herstelvenster is gesloten, of de voorafgaande lees is gelukt en meldde dat de mailserver het account niet meer vasthoudt. Op dat tweede pad wordt het record onderweg verbruikt, dus een nieuwe poging antwoordt 404
  • 400 password_blank | geen wachtwoord meegegeven
  • 422 restore_failed | de mailserver heeft geantwoord en geweigerd, of een latere stap faalde. Het opnieuw proberen waard
  • 503 restore_unavailable | de voorafgaande lees van de lijst met wistaken van de mailserver kon niet worden uitgevoerd, dus er is niets geprobeerd. Het record is onaangeraakt — probeer het opnieuw
  • plus de gedeelde controles

Foutcodes

Alle fouten behalve de OAuth-scopefout gebruiken de standaardenvelop {"errors": [...], "code": "..."} die is beschreven in Foutreacties. Een onbekende of buiten je bereik vallende :mailspace_id is de uitzondering in de andere richting: 404 met een lege body en helemaal geen envelop. Bij Een gearchiveerd bericht downloaden zijn de fouten JSON, ook al is een succes dat niet.

Gedeeld door elk endpoint op deze pagina — zie Gedeelde controles:

Code Status Opgeworpen bij
stalwart_unavailable 503 alle verzoeken
not_authorized 403 POST, PATCH, DELETE
mailspace_suspended 403 alle verzoeken
mailspace_server_mismatch 503 alle verzoeken
pending_delete 403 POST, PATCH, DELETE
not_provisioned 409 alle verzoeken

Per endpoint:

Code Status Opgeworpen door
archived_items_unavailable 503 gearchiveerde mail opvragen
purged_mailboxes_unavailable 503 herstelbare mailboxen opvragen
unknown_archived_item 404 een gearchiveerd item bekijken, terugzetten, downloaden, verwijderen; ook een terugzetting of verwijdering waarvan het item tussen de twee id-lookups verdwijnt
archived_item_lookup_unavailable 503 een gearchiveerd item bekijken, terugzetten, downloaden, verwijderen — de eigendomscontrole kon niet worden uitgevoerd, dus er is niets verstuurd
restore_failed 422 een gearchiveerd item terugzetten; een definitief verwijderde mailbox herstellen
restore_unconfirmed 503 een gearchiveerd item terugzetten — de opdracht is verstuurd en de uitkomst is onbekend
restore_unavailable 503 een definitief verwijderde mailbox herstellen — er is niets geprobeerd
download_unavailable 404 / 503 een gearchiveerd bericht downloaden — 404 het bericht is weg (definitief), 503 elke andere leesfout (opnieuw te proberen)
delete_failed 422 een gearchiveerd item verwijderen
delete_unconfirmed 503 een gearchiveerd item verwijderen — de wissing is verstuurd en kan al zijn uitgevoerd. Onomkeerbaar
unknown_purged_mailbox 404 een definitief verwijderde mailbox herstellen
not_recoverable 409 een definitief verwijderde mailbox herstellen
password_blank 400 een definitief verwijderde mailbox herstellen

Het endpoint voor het bezorglogboek heeft geen eigen foutcodes — alleen de gedeelde controles.