SDK

Instalimi

Një paketë e vetme, pa varësi, çdo runtime serveri.

Instalimi

Lëshimi i parë është 0.0.1. Çdo operacion i dokumentuar ka një metodë, kontrolli i përputhshmërisë i paketës e dështon build-in kur njëra mungon, dhe API-ja që ajo mbështjell është e ndezur në çdo mjedis.

pnpm add @openemail/sdk

send-email.ts

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)

init e konfiguron një herë klientin e përbashkët openemail, dhe çdo modul që importon openemail më pas e merr atë klient. Kapërcejeni dhe thirrja e parë e ndërton klientin nga OPENEMAIL_API_KEY.

Zgjidhja e send() nuk do të thotë se mesazhi është nisur. Një dërgim i planifikuar ose i anulueshëm kthehet si queued ose scheduled dhe përfundon më vonë. Lexoni status, jo faktin që premtimi u zgjidh.

Ku funksionon

Zero varësi në ekzekutim, në Node 20+, Bun, Deno dhe Cloudflare Workers. Përdor fetch-in global dhe asgjë tjetër, dhe mund t'i jepni tuajin.

Dërgohen të dyja, ESM dhe CommonJS, secila me deklarimet e veta të tipeve, kështu që funksionojnë të dyja, import { openemail } from '@openemail/sdk' dhe const { openemail } = require('@openemail/sdk').

Jo në një shfletues. Klienti mban një çelës API të hapësirës së punës që mund të dërgojë mail dhe të lexojë kutinë postare, prandaj refuzon të niset aty ku ekzistojnë window dhe document. Kutitë e përkohshme janë përjashtimi: createTempMail() nuk ka nevojë për çelës dhe funksionon në një faqe.

Ky është një klient **TypeScript/JavaScript**, dhe nuk ka paketë Python, Go, PHP ose Ruby. Nga një gjuhë tjetër API-ja është thjesht HTTP dhe JSON: quickstart-i mban një kërkesë funksionale në tetë gjuhë, dhe dokumenti OpenAPI gjeneron një klient në shumicën e të tjerave.