Zur Dokumentation springen
API

Einen Posteingang erstellen

Stellt eine Adresse aus und liefert das Token, das sie liest. Jedes Feld ist optional, auch der Body.

POSTapi.openemail.uk/temp-mail/inboxes

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

POST /temp-mail/inboxes

Stellt eine Adresse aus und liefert das Token, das sie liest. Jedes Feld ist optional, auch der Body.

Kein Credential

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

Senden Sie überhaupt keinen Authorization-Header. Dies ist die einzige Ressource der API, die ohne einen antwortet. Sie ist oberhalb der Key-Prüfung registriert, statt einen Scope zu bekommen, denn angeboten wird eine Adresse für jemanden, der keine hat, und zuerst nach einem Key zu fragen würde daraus ein Lead-Formular im Gewand eines Werkzeugs machen.

Beispiel

Ein leerer Body ist gültig und der Normalfall: ein generierter local-part auf einer aus dem Pool gewählten Domain, für eine Stunde geliehen.

curl
curl -X POST "$OE/temp-mail/inboxes" -H "Content-Type: application/json" \  -d '{ "localPart": "octopus-signup", "ttlMinutes": 120 }'
Antwort
{  "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, und die einzige Antwort der gesamten API, die token trägt. Speichern Sie es, bevor Sie irgendetwas anderes mit der Adresse tun.

Ein generierter local-part besteht aus zwölf Zeichen eines Alphabets ohne Vokale und ohne verwechselbare Zeichen; er kann also kein Wort ergeben und übersteht es, von einem Bildschirm abgelesen zu werden.

Alles, was abgelehnt werden kann, wird namentlich abgelehnt statt angepasst: 422 unknown_domain, invalid_address, reserved_address oder invalid_parameter für ein ttlMinutes außerhalb von 1 bis 1440; 409 address_taken für einen bereits vergebenen local-part; 429 too_many_inboxes an der Ausstellungsobergrenze; 503 temp_mail_unavailable auf einer Installation ganz ohne Pool-Domain.

Parameter

Body

domainstring
Eine aus `GET /temp-mail/domains`. Lassen Sie sie weg, wählt der Pool zufällig, statt die erste Domain zu füllen. Eine Domain, die jede Wegwerf-Anmeldung im Internet empfängt, verdient sich die passende Reputation, und diese Reputation teilt sich jede Adresse darauf. Eine Domain, die nicht im Pool ist, wird namentlich abgelehnt (422 `unknown_domain`) statt stillschweigend ersetzt, denn Sie hätten die angeforderte Adresse bereits kopiert.
localPartstring
Der Teil vor dem @, falls Sie ihn wählen wollen: 3 bis 32 Zeichen aus Buchstaben, Ziffern, Punkten, Bindestrichen und Unterstrichen, beginnend und endend mit einem Buchstaben oder einer Ziffer. Enger, als RFC 5321 erlaubt, denn dieser String geht in einen URL-Pfad, einen `To:`-Header und eine HTML-Seite. `+` ist ausgeschlossen, da Sub-Adressierung beim Eingang zusammengefasst wird und `alice+bob` daher ein Name wäre, unter dem Sie gar nicht erreichbar sind. Bereits vergebene Namen antworten mit 409 `address_taken`, was zwei Fälle abdeckt: Ein anderer Besucher hält ihn (oder hielt ihn innerhalb der letzten Woche, solange die Adresse noch aus dem Verkehr gezogen ist), und der Eigentümer der Domain hat ihn als echte Adresse angelegt, was unter demselben Code abgelehnt wird, weil Mail dorthin ihn erreicht und nie Sie. `postmaster` und die anderen reservierten Namen antworten mit 422 `reserved_address`.
ttlMinutesnumber
Wie lang die Laufzeit sein soll, in Minuten, von 1 bis 1440. Standard ist 60. Alles außerhalb dieses Bereichs antwortet mit 422 `invalid_parameter` und nennt das Feld, statt still angepasst zu werden. Sie hätten jemandem bereits den angeforderten Ablauf gezeigt. Die 24 Stunden werden ab der Erstellung gemessen, jede vorab genommene Stunde ist also eine Verlängerung, die später nicht mehr ausgegeben werden kann: `ttlMinutes: 120` kommt mit 22 davon zurück und 1440 mit keiner.

Antwort: temp_inbox, plus ein Token

idstring
Die Posteingangs-ID, `tinb_` und vierundzwanzig Hex-Zeichen. Sie steht im Pfad jedes anderen Aufrufs und ist kein Geheimnis. Das Token schon.
addressstring
Die Adresse, die Sie weitergeben. Mail an `that+anything@` erreicht sie ebenfalls, weil Sub-Adressierung vor der Suche zusammengefasst wird.
domainstring
Die Pool-Domain, auf der die Adresse liegt, separat ausgewiesen, damit ein Client die Adresse zum Anzeigen nicht parsen muss.
createdAtstring
ISO-8601. Die 24-Stunden-Obergrenze wird hiervon aus gemessen, nicht ab der letzten Verlängerung.
expiresAtstring
ISO-8601. Danach authentifiziert das Token sofort nicht mehr, und der Aufräumlauf löscht die Mail beim nächsten Durchgang.
extensionsLeftnumber
Wie oft `extend` tatsächlich noch Zeit dazukauft, unter Berücksichtigung beider Obergrenzen: der 23 Verlängerungen, die eine Laufzeit erlaubt, und der 24 Stunden ab `createdAt`, über die sie nie hinauslaufen kann, je nachdem, was zuerst erreicht wird. Ein mit `ttlMinutes: 1440` erstellter Posteingang meldet 0, ohne etwas verbraucht zu haben. Null bedeutet, dass der Aufruf mit 409 antworten würde, und darauf sollte ein Client den Button ausgrauen, statt es durch Drücken herauszufinden.
messageCountnumber
Nachrichten, die dieser Posteingang ANGENOMMEN hat, nicht wie viele angezeigt werden. Der Wert sinkt nicht, wenn Sie eine löschen: Die Obergrenze zählt Eingänge, Löschen gibt also Speicher frei, aber keinen Platz.
messageLimitnumber
Die Obergrenze, mit jedem Posteingang mitgesendet, damit ein Client „voll“ sagen kann, ohne unsere Konstante fest einzucodieren.
lastMessageAtstring | null
Wann zuletzt Mail eingegangen ist, ISO-8601, oder null, wenn noch keine kam. Für jemanden, der zwei Minuten wartet, liest sich null bei einem frischen Posteingang ganz anders als bei einem stillen.
tokenstring
Das Credential, in dieser Antwort und in keiner anderen. `oe_inbox_` und 43 base64url-Zeichen; die Zeile speichert nur einen mit Schlüssel gebildeten Hash, es lässt sich also weder erneut lesen noch wiederherstellen.

Jede andere Posteingangs-Antwort (Abrufen, Verlängern) ist dieses Objekt ohne token.