आपका एप्लिकेशन एक HTTP endpoint को संरचित डेटा भेजता है और संदेश परिणाम या त्रुटि के साथ प्रतिक्रिया प्राप्त करता है। वह अनुरोध और प्रतिक्रिया ही ईमेल API की कार्यशील सतह है।
ईमेल API क्या-क्या संभालता है?
एक sending endpoint प्राप्तकर्ता, विषय, और टेक्स्ट या HTML कंटेंट स्वीकार करता है। जब प्रदाता समर्थन करता है तो यह हेडर, टैग, टेम्पलेट और अटैचमेंट भी स्वीकार कर सकता है।
एक event endpoint या webhook स्वीकृति के बाद क्या हुआ यह रिपोर्ट करता है। सामान्य इवेंट में delivery, bounce, complaint, open और click शामिल हैं। एक receiving API इनबाउंड मेल को आपके एप्लिकेशन के लिए संरचित संदेशों में बदलता है, ताकि आपको मेलबॉक्स पोल न करना पड़े।
ईमेल API SMTP से कैसे अलग है?
SMTP के लिए आपके एप्लिकेशन को कनेक्शन खोलना, प्रमाणित करना, कमांड भेजना और reply codes पढ़ना होता है। ईमेल API इसके बजाय HTTP अनुरोधों का उपयोग करता है, इसलिए एक client library कनेक्शन पुन: उपयोग, JSON एन्कोडिंग, फिर से प्रयास और प्रतिक्रिया पार्सिंग संभाल सकती है।
API तब चुनें जब आपका एप्लिकेशन पहले से HTTP उपयोग करता है, संरचित इवेंट चाहिए, या ऐसे वातावरण में चलता है जहाँ SMTP कनेक्शन खोलना कठिन है। SMTP relay तब चुनें जब कोई मौजूदा मेल लाइब्रेरी या मेल सर्वर पहले से SMTP बोलता है। दोनों रास्ते एक ही संदेश डिलीवर कर सकते हैं।
| कार्य | Sending API | SMTP relay | Mailbox API |
|---|---|---|---|
| संदेश भेजें | हाँ | हाँ | Reply या compose |
| पार्स किया हुआ मेल प्राप्त करें | कुछ प्रदाता | नहीं | हाँ |
| बातचीत का इतिहास पढ़ें | कुछ प्रदाता | नहीं | हाँ |
| डिलीवरी देखें | इवेंट या webhooks | Reply codes और इवेंट | संदेश स्थिति और इवेंट |
उत्पाद ईमेल API शब्द का उपयोग अलग-अलग क्षमता सेट के लिए करते हैं। यह मानने से पहले कि एक API हर पंक्ति को कवर करता है, प्रदाता का स्कीमा जाँचें।
एक API अनुरोध में क्या शामिल होना चाहिए?
वे फ़ील्ड भेजें जो आपका प्रदाता आवश्यक मानता है। लौटाया गया message identifier रिकॉर्ड करें। जब फिर से प्रयास करने पर डुप्लिकेट भेजना नहीं होना चाहिए तो अपनी idempotency key रखें। भेजने से पहले प्राप्तकर्ताओं को मान्य करें। सीक्रेट अपने सर्वर पर रखें।
एक उदाहरण transactional अनुरोध में from, to, subject, text, category: transactional, और सर्वर पर रखी गई idempotency key होती है। इसे भेजने से पहले एक सत्यापित sending domain उपयोग करें।
HTTP प्रतिक्रिया का मतलब है कि सेवा ने अनुरोध स्वीकार कर लिया। Delivery, bounce और complaint इवेंट बाद में आते हैं, इसलिए स्वीकृत प्रतिक्रिया इनबॉक्स में पहुँचने की पुष्टि नहीं करती।
स्वीकृत अनुरोध को इनबॉक्स में पहुँचने का प्रमाण मानने के बजाय बाद के इवेंट के लिए webhooks का उपयोग करें। Delivery और complaint इवेंट बताते हैं कि स्वीकृति के बाद क्या हुआ।
Bird से कैसे भेजें?
आप अपने वर्कस्पेस API key, प्रेषक, प्राप्तकर्ता, कंटेंट और वैकल्पिक मेटाडेटा के साथ Bird का createEmailMessage API कॉल करते हैं। ईमेल भेजने की गाइड अनुरोध और प्रतिक्रिया फ़ील्ड दिखाती है।
Reply और इनबाउंड मेल के लिए, एक मेलबॉक्स बनाएँ और उसके message और delivery इवेंट उपभोग करें। मेलबॉक्स गाइड उन endpoints और webhook नामों को कवर करती है।
सारांश
- ईमेल API HTTP के माध्यम से sending और message इवेंट उपलब्ध कराता है।
- प्रतिक्रिया API स्वीकृति की पुष्टि करती है, इनबॉक्स में पहुँचने की नहीं।
- Idempotency keys सुरक्षित फिर से प्रयास संभव बनाती हैं।
- Bird sending और mailbox APIs प्रत्येक रास्ते के लिए गाइड के साथ उपलब्ध कराता है।