SDK
SDK
OpenEmail API를 위한 타입이 갖춰진 TypeScript 클라이언트. 의존성이 없고, 엔드포인트마다 메서드가 하나씩 있습니다.
개요
API 전체(발송, 템플릿, 추적, 스레드, 초안, 라벨, 연락처, 오디언스, 도메인, 규칙, 웹훅, 캘린더, 설정, 역할, 멤버, 일회용 수신함)를 다루는 하나의 패키지로, 모든 요청과 응답에 대한 타입, 두 개의 오류 클래스, 발송을 중복시킬 수 없는 재시도, 웹훅 서명 검증기를 제공합니다. 런타임 의존성이 없고 ESM과 CommonJS를 지원하며 Node 20+, Bun, Deno, Cloudflare Workers에서 동작합니다. 워크스페이스 키를 사용하므로 서버에서 실행되며, 일회용 수신함만 브라우저에서도 실행됩니다.
pnpm add @openemail/sdkimport { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) await openemail.emails.send({ from: 'Acme Billing <[email protected]>', to: '[email protected]', subject: 'Your September invoice', html: '<p>Invoice attached.</p>',})이동할 곳
바로 앞 탭의 API를 감쌉니다
여기 있는 모든 것은 API 레퍼런스가 문서화하는 것과 같은 표면이므로, 엔드포인트가 무엇을 하는지는 그쪽에서, 어떻게 호출하는지는 여기서 읽으세요. 문서화된 모든 작업마다 메서드가 하나씩 있으며, 패키지의 패리티 검사가 OpenAPI 문서를 읽어 그것을 증명합니다.