Ga direct naar de documentatie
API

Een inbox aanmaken

Geeft een adres uit en geeft het token terug dat het leest. Elk veld is optioneel, inclusief de body.

POSTapi.openemail.uk/temp-mail/inboxes

Voert de echte aanroep uit op je workspace, met je eigen sleutel.

POST /temp-mail/inboxes

Geeft een adres uit en geeft het token terug dat het leest. Elk veld is optioneel, inclusief de body.

Geen credential

shell
export OE=https://api.openemail.uk

Stuur helemaal geen Authorization-header mee. Dit is de enige resource op de API die zonder antwoordt. Hij is boven de keycontrole geregistreerd in plaats van dat hij een scope kreeg, omdat wat er aangeboden wordt een adres is voor iemand die er geen heeft, en eerst om een key vragen zou er een leadformulier van maken in de kleren van een tool.

Voorbeeld

Een lege body is geldig en is het gewone geval: een gegenereerd local-part op een domein dat uit de pool is gekozen, voor een uur gehuurd.

curl
curl -X POST "$OE/temp-mail/inboxes" -H "Content-Type: application/json" \  -d '{ "localPart": "octopus-signup", "ttlMinutes": 120 }'
Antwoord
{  "object": "temp_inbox",  "id": "tinb_9c2f41ab7d3e4c118a0f5d72",  "address": "[email protected]",  "domain": "freemailaddress.com",  "createdAt": "2026-09-01T10:00:00.000Z",  "expiresAt": "2026-09-01T12:00:00.000Z",  "extensionsLeft": 22,  "messageCount": 0,  "messageLimit": 50,  "lastMessageAt": null,  "token": "oe_inbox_kQ8v…"}

201, en het enige antwoord in de hele API dat token draagt. Sla het op voordat je iets anders met het adres doet.

Een gegenereerd local-part is twaalf tekens uit een alfabet zonder klinkers en zonder op elkaar lijkende tekens, zodat het niets kan spellen en het voorlezen vanaf een scherm overleeft.

Alles wat geweigerd kan worden, wordt bij naam geweigerd in plaats van bijgesteld: 422 unknown_domain, invalid_address, reserved_address, of invalid_parameter voor een ttlMinutes buiten 1 tot 1440; 409 address_taken voor een local-part dat al vergeven is; 429 too_many_inboxes bij het uitgifteplafond; 503 temp_mail_unavailable bij een installatie zonder enig gepoold domein.

Parameters

Body

domainstring
Een van `GET /temp-mail/domains`. Laat je het weg, dan kiest de pool willekeurig in plaats van het eerste domein vol te maken. Eén domein dat elke wegwerpaanmelding op internet ontvangt, verdient de bijbehorende reputatie, en die reputatie wordt door elk adres erop gedeeld. Een domein dat niet in de pool zit, wordt bij naam geweigerd (422 `unknown_domain`) in plaats van stilletjes vervangen, omdat je het adres waar je om vroeg al gekopieerd zou hebben.
localPartstring
Het deel vóór de @, als je het zelf wilt kiezen: 3 tot 32 tekens uit letters, cijfers, punten, streepjes en underscores, beginnend en eindigend op een letter of cijfer. Smaller dan RFC 5321 toestaat, omdat deze string in een URL-pad, een `To:`-header en een pagina HTML terechtkomt. `+` is uitgesloten, want subadressering wordt bij binnenkomst samengevouwen, zodat `alice+bob` een naam zou zijn waarop je feitelijk niet bereikbaar bent. Vergeven namen antwoorden 409 `address_taken`, wat twee gevallen dekt: een andere bezoeker heeft hem (of had hem binnen de afgelopen week, terwijl het adres nog uit de roulatie is), en de eigenaar van het domein heeft hem als echt adres aangemaakt, wat onder dezelfde code geweigerd wordt omdat mail eraan bij hem aankomt en nooit bij jou. `postmaster` en de andere gereserveerde namen antwoorden 422 `reserved_address`.
ttlMinutesnumber
Hoe lang de huur moet duren, in minuten, van 1 tot 1440. Standaard 60. Alles buiten dat bereik antwoordt 422 `invalid_parameter` met het veld erbij, in plaats van stilletjes bijgesteld te worden. Je zou iemand de vervaltijd waar je om vroeg al getoond hebben. De 24 uur worden vanaf het aanmaken gemeten, dus elk uur dat je vooraf neemt is een verlenging die je later niet meer kunt besteden: `ttlMinutes: 120` komt terug met 22 verlengingen, en 1440 met geen enkele.

Antwoord: temp_inbox, plus een token

idstring
Het inbox-id, `tinb_` plus vierentwintig hextekens. Het gaat in het pad van elke andere aanroep en het is geen geheim. Het token wel.
addressstring
Het adres dat je uitdeelt. Mail geadresseerd aan `that+anything@` bereikt het ook, omdat subadressering vóór de lookup wordt samengevouwen.
domainstring
Het gepoolde domein waarop het adres zit, apart meegegeven zodat een client het adres niet hoeft te parsen om het te tonen.
createdAtstring
ISO-8601. Het plafond van 24 uur wordt hiervandaan gemeten, niet vanaf de laatste verlenging.
expiresAtstring
ISO-8601. Daarna stopt het token onmiddellijk met authenticeren, en de opruimronde verwijdert de mail bij haar volgende run.
extensionsLeftnumber
Hoe vaak `extend` nog echt tijd oplevert, met beide plafonds meegeteld: de 23 verlengingen die een huur toestaat, en de 24 uur vanaf `createdAt` waar hij nooit voorbij kan lopen, afhankelijk van wat als eerste bereikt wordt. Een inbox die met `ttlMinutes: 1440` is aangemaakt meldt 0 zonder iets besteed te hebben. Nul betekent dat de aanroep 409 zou antwoorden, en daarop hoort een client de knop uit te grijzen in plaats van het te ontdekken door erop te drukken.
messageCountnumber
Berichten die deze inbox heeft GEACCEPTEERD, niet hoeveel er getoond worden. Het gaat niet omlaag als je er een verwijdert: het plafond telt binnenkomsten, dus verwijderen maakt opslag vrij maar geen plek.
messageLimitnumber
Het plafond, bij elke inbox meegestuurd zodat een client "vol" kan zeggen zonder onze constante hard te coderen.
lastMessageAtstring | null
Wanneer er voor het laatst mail binnenkwam, ISO-8601, of null als er nog niets is. Null op een verse inbox leest voor iemand die twee minuten zit te wachten heel anders dan null op een stille inbox.
tokenstring
Het credential, in dit antwoord en in geen enkel ander. `oe_inbox_` plus 43 base64url-tekens; de rij slaat alleen een keyed hash op, dus het kan niet opnieuw gelezen of hersteld worden.

Elk ander inboxantwoord (ophalen, verlengen) is dit object zonder token.