Kalo te dokumentacioni
API

Krijo një inbox

Lëshon një adresë dhe kthen token-in që e lexon atë. Çdo fushë është opsionale, përfshirë body-n.

POSTapi.openemail.uk/temp-mail/inboxes

Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.

POST /temp-mail/inboxes

Lëshon një adresë dhe kthen token-in që e lexon atë. Çdo fushë është opsionale, përfshirë body-n.

Pa kredencial

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

Mos dërgoni fare header Authorization. Ky është i vetmi burim në API që përgjigjet pa të. Ai është i regjistruar mbi kontrollin e çelësit në vend që t'i jepet një scope, sepse ajo që ofrohet është një adresë për dikë që nuk ka një të tillë, dhe kërkesa për çelës së pari do ta kthente në një formular gjenerimi kontaktesh të veshur si mjet.

Shembull

Një body bosh është i vlefshëm dhe është rasti i zakonshëm: një local-part i gjeneruar në një domen të zgjedhur nga pool-i, me afat një orë.

curl
curl -X POST "$OE/temp-mail/inboxes" -H "Content-Type: application/json" \  -d '{ "localPart": "octopus-signup", "ttlMinutes": 120 }'
Përgjigje
{  "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, dhe e vetmja përgjigje në të gjithë API-n që mbart token. Ruajeni atë përpara se të bëni çdo gjë tjetër me adresën.

Një local-part i gjeneruar është dymbëdhjetë karaktere nga një alfabet pa zanore dhe pa karaktere që ngjajnë me njëri-tjetrin, prandaj nuk mund të formojë asnjë fjalë dhe i mbijeton leximit nga një ekran.

Çdo gjë që mund të refuzohet refuzohet me emër, në vend që të rregullohet: 422 unknown_domain, invalid_address, reserved_address, ose invalid_parameter për një ttlMinutes jashtë 1 deri 1440; 409 address_taken për një local-part tashmë të zënë; 429 too_many_inboxes te tavani i krijimit; 503 temp_mail_unavailable në një install pa asnjë domen pool-i.

Parametrat

Trupi

domainstring
Një nga `GET /temp-mail/domains`. Lëreni jashtë dhe pool-i zgjedh rastësisht në vend që të mbushë domenin e parë. Një domen i vetëm që merr çdo regjistrim të njëhershëm të internetit fiton reputacionin përkatës, dhe atë reputacion e ndan çdo adresë në të. Një domen që nuk është në pool refuzohet me emër (422 `unknown_domain`) në vend që të zëvendësohet në heshtje, sepse ju do ta kishit kopjuar tashmë adresën që kërkuat.
localPartstring
Pjesa përpara @-së, nëse doni ta zgjidhni: 3 deri 32 karaktere nga shkronja, shifra, pika, viza dhe nënviza, që fillojnë dhe mbarojnë me shkronjë ose shifër. Më e ngushtë nga sa lejon RFC 5321, sepse ky varg shkon në një rrugë URL-je, në një header `To:` dhe në një faqe HTML. `+` përjashtohet, meqë nën-adresimi bashkohet gjatë hyrjes, prandaj `alice+bob` do të ishte një emër te i cili nuk do të mund të arriheshit në të vërtetë. Emrat e zënë përgjigjen me 409 `address_taken`, që mbulon dy raste: e mban një vizitor tjetër (ose e ka mbajtur brenda javës së fundit, ndërsa adresa është ende jashtë qarkullimit), dhe pronari i domenit e ka krijuar si adresë të vërtetë, gjë që refuzohet nën të njëjtin kod sepse posta drejt saj arrin te ai dhe kurrë te ju. `postmaster` dhe të rezervuarat e tjera përgjigjen me 422 `reserved_address`.
ttlMinutesnumber
Sa i gjatë duhet të jetë afati, në minuta, nga 1 deri 1440. Parazgjedhja është 60. Çdo gjë jashtë atij intervali përgjigjet me 422 `invalid_parameter` që emërton fushën, në vend që të rregullohet në heshtje. Ju do t'i kishit treguar tashmë dikujt skadimin që kërkuat. 24 orët maten nga krijimi, prandaj çdo orë e marrë që në fillim është një zgjatje që nuk mund të shpenzohet më vonë: `ttlMinutes: 120` kthehet me 22 prej tyre, ndërsa 1440 me asnjë.

Përgjigje: temp_inbox, plus një token

idstring
Id-ja e inbox-it, `tinb_` dhe njëzet e katër karaktere hex. Ajo shkon në rrugën e çdo thirrjeje tjetër, dhe nuk është sekret. Token-i është.
addressstring
Adresa për t'ia dhënë tjetrit. Posta drejtuar `that+anything@` e arrin gjithashtu, sepse nën-adresimi bashkohet përpara kërkimit.
domainstring
Domeni i pool-it në të cilin ndodhet adresa, i ndarë veçmas që një klient të mos ketë nevojë ta parsojë adresën për ta treguar.
createdAtstring
ISO-8601. Tavani prej 24 orësh matet nga kjo, jo nga zgjatja e fundit.
expiresAtstring
ISO-8601. Pas saj token-i ndalon menjëherë së autentikuari, dhe fshirja periodike e fshin postën në ekzekutimin e vet të radhës.
extensionsLeftnumber
Sa herë të tjera `extend` do të blejë vërtet kohë, duke numëruar të dy tavanet: 23 zgjatjet që lejon një afat, dhe 24 orët nga `createdAt` përtej të cilave nuk shkon kurrë, cilado të arrihet e para. Një inbox i krijuar me `ttlMinutes: 1440` raporton 0 pa shpenzuar asgjë. Zero do të thotë se thirrja do të përgjigjej me 409, dhe mbi këtë duhet ta çaktivizojë butonin një klient, në vend që ta zbulojë duke e shtypur.
messageCountnumber
Mesazhet që ka PRANUAR ky inbox, jo sa po shfaqen. Nuk zbret kur fshini një: tavani numëron mbërritjet, prandaj fshirja liron hapësirë ruajtjeje, por jo vend.
messageLimitnumber
Tavani, i dërguar në çdo inbox që një klient të mund të thotë "plot" pa e koduar fort konstanten tonë.
lastMessageAtstring | null
Kur mbërriti posta e fundit, ISO-8601, ose null nëse nuk ka mbërritur asnjë. Një null në një inbox të sapokrijuar lexohet krejt ndryshe nga një inbox i qetë, për dikë që ka pritur dy minuta.
tokenstring
Kredenciali, në këtë përgjigje dhe në asnjë tjetër. `oe_inbox_` dhe 43 karaktere base64url; rreshti ruan vetëm një hash me çelës, prandaj ai nuk mund të rilexohet ose të rikthehet.

Çdo përgjigje tjetër inbox-i (retrieve, extend) është ky objekt pa token.