تخطَّ إلى المستندات
SDK

SDK

عميل TypeScript مُحدَّد الأنواع لواجهة OpenEmail API. بلا أي اعتماديات، ودالة واحدة لكل نقطة نهاية.

ما هي

حزمة واحدة تغطي الـ API كاملة (الإرسال، والقوالب، والتتبّع، والمحادثات، والمسودّات، والتصنيفات، وجهات الاتصال، والجماهير، والنطاقات، والقواعد، وخطافات الويب، والتقويم، والإعدادات، والأدوار، والأعضاء، وصناديق البريد المؤقتة) مع أنواع لكل طلب واستجابة، وصنفَي خطأ، وإعادات محاولة لا يمكن أن تُكرّر إرسالًا، ومُتحقّق من توقيع خطافات الويب. بلا اعتماديات وقت التشغيل، بصيغتَي 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>',})

إلى أين تذهب

يغلّف الـ API الموجود في التبويب السابق لهذا

كل ما هنا هو السطح نفسه الذي يوثّقه مرجع الـ API، فاقرأ ذاك لمعرفة ما تفعله نقطة النهاية واقرأ هذا لمعرفة كيفية استدعائها. وهناك دالة واحدة لكل عملية موثّقة، وفحص التطابق في الحزمة يقرأ مستند OpenAPI ليثبت ذلك.