SDK - OpenEmail

SDK

OpenEmail API 向けの型付き TypeScript クライアント。依存関係はゼロで、エンドポイントごとに 1 つのメソッドがある。

概要

API 全体（送信、テンプレート、トラッキング、スレッド、ドラフト、ラベル、連絡先、オーディエンス、ドメイン、ルール、webhook、カレンダー、設定、ロール、メンバー、使い捨て受信箱）を 1 つのパッケージで覆い、すべてのリクエストとレスポンスの型、2 つのエラークラス、送信を重複させないリトライ、webhook の署名検証を備える。ランタイム依存はなく、ESM と CommonJS に対応し、Node 20+、Bun、Deno、Cloudflare Workers で動く。ワークスペースのキーを持つのでサーバー上で動かすものであり、ブラウザでも動くのは使い捨て受信箱の部分だけである。

pnpm add @openemail/sdk

send-email.ts

import { 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>',})

次に読む

インストール追加して、最初のメッセージを送る。設定すべてのオプションと、何を拒否するか。メールを送信するメッセージのすべてのフィールド。スレッド読む、整理する、スヌーズする、添付ファイル。Webhookエンドポイントを登録し、検証する。エラー何が throw されるか、どう絞り込むか。リトライリトライした送信が重複しない理由。すべてのメソッド完全な一覧を、1 行ずつ。

1 つ前のタブにある API をラップしている

ここにあるものはすべて、API リファレンスが記述しているのと同じ面である。エンドポイントが何をするかはそちらを、どう呼び出すかはこちらを読むこと。文書化されたすべての操作に 1 つのメソッドが対応し、パッケージのパリティチェックが OpenAPI ドキュメントを読んでそれを証明する。

API リファレンス各エンドポイントが何をし、どう失敗するか。