आपका ऐप्लिकेशन एक HTTP एंडपॉइंट पर संरचित डेटा भेजता है और बदले में संदेश के परिणाम या किसी त्रुटि वाली प्रतिक्रिया पाता है। यही अनुरोध और प्रतिक्रिया ईमेल API के साथ काम करने का मुख्य माध्यम हैं।
ईमेल API कौन-से काम संभालता है?
भेजने वाला एंडपॉइंट प्राप्तकर्ता, विषय और टेक्स्ट या HTML सामग्री स्वीकार करता है। अगर प्रदाता इनका समर्थन करता है, तो यह हेडर, टैग, टेम्पलेट और अटैचमेंट भी स्वीकार कर सकता है।
इवेंट एंडपॉइंट या webhook बताता है कि संदेश स्वीकार होने के बाद क्या हुआ। आम इवेंट हैं: डिलीवरी, बाउंस, शिकायत, ओपन और क्लिक। प्राप्त करने वाला API आने वाले मेल को आपके ऐप्लिकेशन के लिए संरचित संदेशों में बदलता है, ताकि आपको बार-बार मेलबॉक्स जाँचना न पड़े।
ईमेल API, SMTP से कैसे अलग है?
SMTP में आपके ऐप्लिकेशन को कनेक्शन खोलना, प्रमाणीकरण करना, कमांड भेजना और रिप्लाई कोड पढ़ना पड़ता है। ईमेल API इसके बजाय HTTP अनुरोधों का उपयोग करता है, इसलिए क्लाइंट लाइब्रेरी कनेक्शन का दोबारा उपयोग, JSON एन्कोडिंग, फिर से प्रयास करना और प्रतिक्रिया पार्स करना संभाल सकती है।
अगर आपका ऐप्लिकेशन पहले से HTTP का उपयोग करता है, उसे संरचित इवेंट चाहिए, या वह ऐसी जगह चलता है जहाँ SMTP कनेक्शन खोलना मुश्किल है, तो API चुनें। अगर कोई मौजूदा मेल लाइब्रेरी या मेल सर्वर पहले से SMTP इस्तेमाल करता है, तो SMTP रिले चुनें। दोनों तरीकों से एक ही संदेश डिलीवर हो सकता है।
| काम | भेजने वाला API | SMTP रिले | मेलबॉक्स API |
|---|---|---|---|
| संदेश भेजना | हाँ | हाँ | जवाब देना या नया संदेश लिखना |
| पार्स किया गया मेल प्राप्त करना | कुछ प्रदाता | नहीं | हाँ |
| बातचीत का इतिहास पढ़ना | कुछ प्रदाता | नहीं | हाँ |
| डिलीवरी पर नज़र रखना | इवेंट या वेबहुक | रिप्लाई कोड और इवेंट | मैसेज स्टेटस और इवेंट |
अलग-अलग प्रोडक्ट email API शब्द का इस्तेमाल अलग-अलग क्षमताओं के लिए करते हैं। यह मानने से पहले कि एक API हर पंक्ति को कवर करता है, प्रोवाइडर का स्कीमा जाँचें।
API अनुरोध में क्या शामिल होना चाहिए?
वे फ़ील्ड भेजें जो आपका प्रोवाइडर माँगता है। लौटाया गया मैसेज आइडेंटिफ़ायर रिकॉर्ड करें। जब फिर से प्रयास करने से डुप्लिकेट भेजना नहीं बनना चाहिए, तब अपनी idempotency कुंजी रखें। भेजने से पहले प्राप्तकर्ताओं को सत्यापित करें। सीक्रेट अपने सर्वर पर ही रखें।
एक उदाहरण ट्रांज़ैक्शनल अनुरोध में from, to, subject, text, category: transactional और सर्वर पर रखी गई एक idempotency कुंजी होती है। इसे भेजने से पहले एक सत्यापित सेंडिंग डोमेन इस्तेमाल करें।
HTTP प्रतिक्रिया का मतलब है कि सेवा ने अनुरोध स्वीकार कर लिया है। डिलीवरी, बाउंस और शिकायत इवेंट बाद में आते हैं, इसलिए स्वीकृत प्रतिक्रिया से यह साबित नहीं होता कि मैसेज इनबॉक्स में पहुँचा।
स्वीकृत अनुरोध को इस बात का सबूत न मानें कि मैसेज इनबॉक्स तक पहुँच गया; बाद के इवेंट के लिए वेबहुक इस्तेमाल करें। डिलीवरी और शिकायत इवेंट बताते हैं कि स्वीकृति के बाद क्या हुआ।
Bird से ईमेल कैसे भेजें?
आप अपनी वर्कस्पेस API कुंजी, प्रेषक, प्राप्तकर्ता, सामग्री और वैकल्पिक मेटाडेटा के साथ Bird के createEmailMessage API को कॉल करते हैं। ईमेल भेजने की गाइड में अनुरोध और प्रतिक्रिया के फ़ील्ड दिए गए हैं।
जवाबों और आने वाले मेल के लिए एक मेलबॉक्स बनाएँ और उसके मैसेज और डिलीवरी इवेंट प्राप्त करें। मेलबॉक्स गाइड में उन एंडपॉइंट और वेबहुक के नाम दिए गए हैं।
संक्षेप में
- ईमेल API भेजने की सुविधा और मैसेज इवेंट HTTP के ज़रिए उपलब्ध कराता है।
- प्रतिक्रिया API द्वारा स्वीकृति की पुष्टि करती है, इनबॉक्स तक पहुँचने की नहीं।
- आइडेम्पोटेंसी कुंजियों से सुरक्षित रूप से फिर से प्रयास करना संभव होता है।
- Bird भेजने और मेलबॉक्स के API देता है, और हर तरीके के लिए गाइड उपलब्ध है।