Izstrādātāji

Pastkastītei ir vienalga,
kas to vada.

Visu, ko dara lietotne, dara arī jūsu kods: 104 dokumentētas operācijas 68 ceļos, aiz OpenAPI 3.1 dokumenta, ko var izlasīt bez atslēgas. TypeScript klients katrā būvējumā tiek turēts pie šī dokumenta.

Ielīmējiet jebkurā MCP klientā. Tas reģistrējas pats.

{ "mcpServers": {
    "openemail": {
      "url": "https://api.openemail.uk/mcp"
    } } }

MCP nav jāielīmē nekāda atslēga. Klients no galapunkta atrod autorizācijas serveri, reģistrējas pats un nosūta jūs šurp pieteikties.

104

dokumentētas operācijas

ceļi zem viena resursdatora

116

SDK metodes, kas aptver tās visas

webhook notikumi trīs saimēs

OpenAPI 3.1 dokuments ir pieejams ar GET /openapi.json, un tā lasīšanai atslēga nav vajadzīga.

Saskarnes

Trīs durvis,
viena pastkastīte.

REST API

Darbvietas atslēga nosaka, ko izsaukums drīkst darīt un kuru adrešu vārdā tas drīkst sūtīt. Atsaukšana ir atjauninājums, nevis dzēšana, tāpēc vēlākam izsaukumam tiek pateikts, ka atslēga ir atsaukta.

/threads?query=invoice

/emails

emails:sendthreads:readwebhooks:write

Viena atslēga sūta līdz 25 veselu domēnu un 50 atsevišķu adrešu vārdā. GET /ping nolasa atpakaļ tās tvērumus un tos tvērumus, ko tai atstāja tās loma.

MCP serveris

Norādiet klientam galapunktu un piesakieties. Nav nekādas atslēgas, ko ielīmēt, jo klients reģistrējas pats un nosūta jūs šurp.

listThreads

threads:reademails:sendlabels:write

Rīki tiek veidoti no tā, ko izsaucējs drīkst darīt, tāpēc klientam, kas turēts pie lasīšanas, sūtīšanas rīka nav. Marķieris tik un tā sniedzas līdz visai pastkastītei.

Webhook izsaukumi

Reģistrējiet https galapunktu, un pastkastīte uz to sūtīs. Piegādes ceļ pati pastkastīte, nevis API izsaukums, tāpēc rakstīšana lietotnē un sūtīšana uz API izraisa vienu un to pašu.

/webhooks

email.receivedemail.sentemail.failedemail.openeddomain.verifiedsuppression.added

20 notikumi trīs saimēs un desmit galapunkti uz pastkastīti.

Paritāte

Klients nevar atpalikt
no API.

Paritātes pārbaude katrā būvējumā nolasa OpenAPI dokumentu un krīt pie novirzes: metode, kas norāda uz operāciju, kuras specifikācijā nav, dokumentēta operācija bez metodes vai tvērumu saraksts, kas nesakrīt ar to, ko operācija prasa. Tā izdrukā, ko pierādīja, un šodien tas skan: 116 SDK metodes pār visām 104 dokumentētajām operācijām.

Viens sūtījums, trīs veidi

Konfigurācija, pieprasījums un izsaukums ir viena un tā pati operācija, uzrakstīta trīs veidos.

MCPAPISDK

{ "mcpServers": {

"openemail": {

"url": "https://api.openemail.uk/mcp"

} } }

01 · 5 funkcijas, 1 vēl tapšanā

Aģenti, API un MCP

OpenEmail ir domāts, lai to darbinātu gan programmatūra, gan cilvēki. Pastkastīte abos gadījumos ir viena un tā pati.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

MCP serveris

Norādiet Claude vai jebkuram MCP klientam savu pastkastīti.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

OAuth trešo pušu klientiem

Drīzumā

Pašapkalpošanās klientu reģistrācija ar PKCE, lai lietotne varētu pieprasīt piekļuvi kārtīgi.

Piekrišana un atsaukšana ir šeit; tvērums nav, tāpēc marķieris piekļūst visai jūsu pastkastei, nevis tikai tai daļai, ko lietotne prasīja.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

REST API

Dokumentēts HTTP API ar izdodamām, tvērumā ierobežojamām un atsaucamām atslēgām.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

Tipizēti SDK

Vispirms TypeScript klients, tad pārējie.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

Tīmekļa āķi

Paziņo jūsu galapunktam, kad pienāk pasts, nevis liek jums to aptaujāt.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

Ātrais sākums

No nekā līdz nosūtītai vēstulei.
Trīs soļi.

1
Izveidojiet atslēgu
Iestatījumi, API atslēgas, jums piederošā pastkastītē. Izvēlieties tās tvērumus un sašauriniet, kā vārdā tā drīkst sūtīt, līdz veseliem domēniem vai atsevišķām adresēm. Noslēpums tiek parādīts vienreiz, un glabāts tiek vienvirziena jaucējkods.
GET /ping atbild ar atslēgas tvērumiem un tiem tvērumiem, ko tai atstāja tās loma.
export OPENEMAIL_API_KEY=oe_live_9f2c1a4b7e05d3862c1f0a44_kX7… curl https://api.openemail.uk/ping \ -H "Authorization: Bearer $OPENEMAIL_API_KEY"
2
Instalējiet klientu
TypeScript klients bez atkarībām, publicēts kā ESM un CommonJS, kas nolasa atslēgu no OPENEMAIL_API_KEY. Izlaidiet to, ja labāk JSON sūtīsiet paši, jo katrs galapunkts ir vienkāršs HTTP.
Node 18 un jaunāks, Workers, Deno, Bun un pārlūks.
bun add @openemail/sdk

Sūtiet

Atbilde nes id. GET /emails/{id} to atrisina, /events glabā pēdas par katru saņēmēju, un /tracking glabā atvēršanas un klikšķus.

Atkārtots mēģinājums ar to pašu Idempotency-Key atgriež pirmo rezultātu ar Idempotency-Replayed: true.

import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) const email = await openemail.emails.send({  from: 'Acme Billing <[email protected]>',  to: '[email protected]',  subject: 'Your September invoice',  html: '<p>Invoice attached.</p>',}) console.log(email.id, email.status)

Trūkst

Ko tas vēl nedarīs
jūsu labā.

Piecas lietas, ko vērts zināt pirms būvēšanas uz šī, nevis pēc tam.

Nav augšupielādes galapunkta: Iekļautie pielikumi iet kā base64 ar 5 MB kopējo ierobežojumu. Lielāku failu sūta, nosaucot darbvietā jau esošu failu pēc tā id, kas ceļo kā lejupielādes saite.
Atlēcieni apstājas pie pastkastītes: Piegādes atskaite tiek parsēta, sasaistīta pēc Message-ID, atzīmēta sarakstē un nosūtīta kā email.bounced webhook. Nekas netiek ierakstīts atpakaļ sūtījuma rindā, tāpēc caur GET /emails atlēkusi vēstule joprojām lasās kā nosūtīta.
Sastādītāja pasts nav GET /emails: Pasts, kas nosūtīts no lietotnes sastādītāja, šajā sarakstā neparādās, jo sastādītājs neraksta pa to pašu sūtīšanas ceļu.
OAuth ir piekrišana, nevis tvērums: Pieprasījums tiek parādīts pirms piešķiršanas, un Pievienotās lietotnes to paņem atpakaļ, taču marķieris sniedzas līdz visai jūsu pastkastītei, nevis tikai tai daļai, ko lietotne prasīja.
Nav izlaiduma darbplūsmas: Klienta publicēšana ir manuāla pārbaudes, būvējuma un bun publish palaišana, tāpēc versija nonāk npm tad, kad kāds to palaiž, nevis tad, kad izmaiņa ienāk.

Piegādes pārbaude

Katra piegāde ir parakstīta,
un katrs atkārtojums nes tās id.

Paraksts ir HMAC-SHA-256 pār laika zīmogu, punktu un neapstrādāto saturu. Pārbaudiet pret baitiem tādiem, kādi tie pienāca, jo parsēšana un atkārtota serializēšana pārkārto atslēgas un to salauž.

Galvenes katrā piegādē

X-OpenEmail-Signature: t=1758240000,v1=9f0c4b2e7d1a86c3X-OpenEmail-Event: email.deliveredX-OpenEmail-Delivery: evt_4b7e05d3862c1f0a

Atkārtojuma logs: 300 sekundes, un to ievērot ir saņēmēja uzdevums. SDK pārbaudītājs to izmanto pēc noklusējuma.
Idempotency-Key: Pieteikts pret unikālu indeksu uz atslēgas un jūsu API atslēgas kopā, tāpēc atkārtots mēģinājums pēc noildzes atgriež pirmo rezultātu ar Idempotency-Replayed: true, nevis sūta divreiz.
Atkārtojumi: Pieci mēģinājumi: notikuma brīdī, tad pēc 1 minūtes, 5, 25 un 2 stundām. Atkārto tikai noildzi, atteiktu savienojumu, 408, 425, 429 vai 5xx.
X-OpenEmail-Delivery: Notikuma id tiek izveidots vienu reizi, un to nes katrs mēģinājums, tāpēc saņēmējs, kas vienu un to pašu id redz divreiz, otro var nomest, nevis rīkoties atkārtoti.

Kam tas domāts

Viena pastkaste.
Trīs ceļi iekšā.

Privātpersonas

Bezmaksas adrese domēnā openemail.uk, un aiz tās klients.

acme.comacme.devstudio.acme.com

hello@acme.compiegādāts

billing@acme.compiegādāts

oct-2026-signup@acme.compiegādāts

anything-at-all@acme.compiegādāts

Uzņēmumi

Adreses visiem, dalībniekus nekad neskaita kā vietas.

[email protected]koplietots

SSarahAAliJJamieNNadia

Neviena vieta nav pievienota. Rēķins nemainās.

Izstrādātāji

Tā pati pastkaste caur API, SDK un MCP.

/threads?query=invoice

{ "threads": 12 }

Viena un tā pati pastkaste — vai to tur cilvēks, vai programma.

Izveidojiet atslēgu.
Nosūtiet kaut ko.

Full API, MCP and SDK access katrā plānā. Free nes 50 AI actions a day sev līdzi.

Izlasiet API ātro sākumu

Pastkastītei ir vienalga,kas to vada.

Trīs durvis,viena pastkastīte.

Klients nevar atpaliktno API.

Aģenti, API un MCP

MCP serveris

OAuth trešo pušu klientiem

REST API

Tipizēti SDK

Tīmekļa āķi

No nekā līdz nosūtītai vēstulei.Trīs soļi.

Ko tas vēl nedarīsjūsu labā.

Katra piegāde ir parakstīta,un katrs atkārtojums nes tās id.

Viena pastkaste.Trīs ceļi iekšā.

Izveidojiet atslēgu.Nosūtiet kaut ko.

Jūsu iesūtne,uz jūsu noteikumiem.

Pastkastītei ir vienalga,
kas to vada.

Trīs durvis,
viena pastkastīte.

Klients nevar atpalikt
no API.

No nekā līdz nosūtītai vēstulei.
Trīs soļi.

Ko tas vēl nedarīs
jūsu labā.

Katra piegāde ir parakstīta,
un katrs atkārtojums nes tās id.

Viena pastkaste.
Trīs ceļi iekšā.

Izveidojiet atslēgu.
Nosūtiet kaut ko.

Jūsu iesūtne,
uz jūsu noteikumiem.