SDK

Cài đặt

Một gói, không phụ thuộc, mọi runtime máy chủ.

Cài đặt

Bản phát hành đầu tiên là 0.0.1. Mọi thao tác có trong tài liệu đều có một phương thức, bài kiểm tra tương đương của gói sẽ làm hỏng bản build khi thiếu một cái, và API mà nó bao bọc đang bật ở mọi môi trường.

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 cấu hình client openemail dùng chung một lần duy nhất, và sau đó mọi module import openemail đều nhận được client ấy. Bỏ qua nó thì lời gọi đầu tiên sẽ dựng client từ OPENEMAIL_API_KEY.

send() resolve không có nghĩa là thông điệp đã đi. Một lần gửi có hẹn giờ hoặc có thể huỷ sẽ trả về queued hoặc scheduled và ổn định muộn hơn. Hãy đọc status, chứ không phải việc promise đã resolve.

Nơi nó chạy được

Không phụ thuộc runtime nào, chạy trên Node 20+, Bun, Deno và Cloudflare Workers. Nó chỉ dùng fetch toàn cục và không gì khác, và bạn có thể đưa cho nó bản fetch của riêng mình.

Cả ESM lẫn CommonJS đều được phát hành, mỗi bản có khai báo kiểu riêng, nên import { openemail } from '@openemail/sdk' và const { openemail } = require('@openemail/sdk') đều chạy được.

Không dùng trong trình duyệt. Client mang một API key của workspace có thể gửi thư và đọc hộp thư, nên nó từ chối khởi động ở nơi có window và document. Hộp thư dùng một lần là ngoại lệ: createTempMail() không cần khoá và chạy được ngay trong một trang web.

Đây là một client **TypeScript/JavaScript**, và không có gói Python, Go, PHP hay Ruby. Từ một ngôn ngữ khác, API chỉ là HTTP và JSON thuần: phần quickstart có sẵn một yêu cầu chạy được bằng tám ngôn ngữ, và tài liệu OpenAPI sinh ra client cho hầu hết các ngôn ngữ còn lại.