दस्तावेज़ पर जाएँ
SDK

SDK

OpenEmail API के लिए टाइप किया हुआ TypeScript क्लाइंट। कोई डिपेंडेंसी नहीं, और हर endpoint के लिए एक मेथड।

यह क्या है

पूरे API पर एक ही पैकेज (भेजना, टेम्पलेट, ट्रैकिंग, थ्रेड, ड्राफ़्ट, लेबल, संपर्क, ऑडियंस, डोमेन, नियम, वेबहुक, कैलेंडर, सेटिंग्स, रोल, सदस्य और डिस्पोज़ेबल इनबॉक्स), हर अनुरोध और जवाब के लिए टाइप, दो एरर क्लास, ऐसी रीट्राई जो किसी सेंड को दोहरा नहीं सकतीं, और एक वेबहुक सिग्नेचर वेरिफ़ायर के साथ। कोई रनटाइम डिपेंडेंसी नहीं, ESM और CommonJS, Node 20+, Bun, Deno और Cloudflare Workers पर। यह वर्कस्पेस key रखता है, इसलिए यह सर्वर पर चलता है, और डिस्पोज़ेबल इनबॉक्स ही वह एक हिस्सा है जो ब्राउज़र में भी चलता है।

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

आगे कहाँ जाएँ

इंस्टॉलइसे जोड़ें और अपना पहला संदेश भेजें।कॉन्फ़िगरेशनहर विकल्प, और वह क्या अस्वीकार करता है।ईमेल भेजेंसंदेश का हर फ़ील्ड।थ्रेडपढ़ना, व्यवस्थित करना, स्नूज़, अटैचमेंट।वेबहुककोई endpoint रजिस्टर करें और उसे सत्यापित करें।एररक्या फेंका जाता है, और उसका प्रकार कैसे तय करें।रीट्राईदोबारा आज़माया गया सेंड दोहरा क्यों नहीं हो सकता।हर मेथडपूरी सूची, हर एक के लिए एक पंक्ति।

यह इससे पिछले टैब वाले API को लपेटता है

यहाँ सब कुछ वही सतह है जिसका ब्योरा API संदर्भ देता है, इसलिए कोई endpoint क्या करता है यह वहाँ पढ़ें और उसे कैसे बुलाना है यह यहाँ। हर दर्ज की गई क्रिया के लिए एक मेथड है, और पैकेज की parity जाँच इसे साबित करने के लिए OpenAPI दस्तावेज़ पढ़ती है।

API संदर्भहर endpoint क्या करता है, और वह कैसे विफल होता है।