Instalēšana
Viena pakotne, nekādu atkarību, katra servera izpildvide.
Instalēšana
Pirmais laidiens ir 0.0.1. Katrai dokumentētajai operācijai ir sava metode, pakotnes atbilstības pārbaude sabojā būvējumu, kad kāda pazūd, un API, ko tā ietin, ir ieslēgts katrā vidē.
pnpm add @openemail/sdkimport { 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)init vienreiz konfigurē koplietoto openemail klientu, un katrs modulis, kas pēc tam importē openemail, saņem tieši to klientu. Izlaid to, un pirmais izsaukums klientu izveidos no OPENEMAIL_API_KEY.
Tas, ka send() atrisinās, nenozīmē, ka ziņojums ir aizgājis. Ieplānots vai atceļams sūtījums atnāk kā queued vai scheduled un nokārtojas vēlāk. Lasi status, nevis to, ka solījums atrisinājās.
Kur tas darbojas
Nulle izpildlaika atkarību; darbojas uz Node 20+, Bun, Deno un Cloudflare Workers. Tā izmanto globālo fetch un neko citu, un tu vari padot savu.
Tiek piegādāts gan ESM, gan CommonJS, katrs ar savām tipu deklarācijām, tāpēc strādā gan import { openemail } from '@openemail/sdk', gan const { openemail } = require('@openemail/sdk').
Ne pārlūkā. Klients nes darbvietas API atslēgu, kas var sūtīt pastu un lasīt pastkasti, tāpēc tas atsakās startēt tur, kur pastāv window un document. Vienreizlietojamās iesūtnes ir izņēmums: createTempMail() neprasa atslēgu un darbojas lapā.
Šis ir **TypeScript/JavaScript** klients, un Python, Go, PHP vai Ruby pakotnes nav. No citas valodas API ir vienkāršs HTTP un JSON: ātrajā startā ir strādājošs pieprasījums astoņās valodās, un OpenAPI dokuments ģenerē klientu lielākajai daļai pārējo.