एक पत्र भेजें
/v1/mailboxes/{mailbox_id}/sendआवश्यक Idempotency-Key 8-128 अक्षर। एक ही कुंजी और बॉडी के साथ दोहराने से वही ऑपरेशन वापस आता है; दूसरा निकाय 409 देता है। HTTP 202 का अर्थ है कतार में लगना। ऑपरेशन की स्थिति की जाँच करें, न कि इस तथ्य की कि कोई प्रतिक्रिया प्राप्त हुई थी।
प्राधिकरण और पहुंच क्षेत्र · त्रुटियाँ और दोहराव
अनुरोध
curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/send' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: message-20261019-0001' \ -H 'Content-Type: application/json' \विकल्प
mailbox_idpathअनिवार्य रूप सेintegerX-Customer-IDheader- विकल्प 1
stringविकल्प 2null Idempotency-Keyheaderअनिवार्य रूप सेstringminLength: 8maxLength: 128
निकाय से अनुरोध करें · application/json
object
toअनिवार्य रूप सेarrayमुख्य प्राप्तकर्ताओं के पते.
minItems: 1maxItems: 50सरणी तत्वstringccarrayअन्य प्रतिभागियों को दिखाई देने वाले प्राप्तकर्ता पते की प्रतिलिपि बनाएँ।
maxItems: 50सरणी तत्वstringbccarrayप्राप्तकर्ता पते की गुप्त प्रतिलिपि.
maxItems: 50सरणी तत्वstringsubjectstringपत्र का विषय.
गलती करना:
""maxLength: 998textstringबिना फ़ॉर्मेट किए पत्र का पाठ.
गलती करना:
""maxLength: 200000htmlपत्र का HTML-स्वरूपित संस्करण।
विकल्प 1stringmaxLength: 300000विकल्प 2nullfile_idsarrayइस मेलबॉक्स में ID पहले डाउनलोड की गई फ़ाइलें। डाउनलोड करते समय या फ़ाइलों की सूची से उन्हें प्राप्त करें।
maxItems: 20सरणी तत्वstring · uuidforward_messageमूल ईमेल जिसके अनुलग्नकों को अग्रेषित करने की आवश्यकता है।
विकल्प 1objectfolderअनिवार्य रूप सेstringफ़ोल्डर सूची से फ़ोल्डर का नाम, उदाहरण के लिए INBOX.
minLength: 1maxLength: 255uidvalidityअनिवार्य रूप सेintegerइस फ़ोल्डर के लिए प्रतिक्रिया API से मान uidvalidity है।
exclusiveMinimum: 0uidअनिवार्य रूप सेintegerexclusiveMinimum: 0
अज्ञात फ़ील्ड स्वीकार नहीं किए जाते.
विकल्प 2nullreply_to_message_idआप जिस ईमेल का उत्तर दे रहे हैं उसका message_id मान।
विकल्प 1stringmaxLength: 998विकल्प 2nullreferencesउत्तर श्रृंखला को सहेजने के लिए मूल संदेश का मान references है।
विकल्प 1stringmaxLength: 4000विकल्प 2nullsend_atसमय क्षेत्र के साथ विलंबित प्रेषण समय, उदाहरण के लिए 2026-11-01T12:00:00Z. मूल्य के बिना, कतार संसाधित होते ही प्रेषण शुरू हो जाता है।
विकल्प 1string · date-timeविकल्प 2null
अज्ञात फ़ील्ड स्वीकार नहीं किए जाते.
प्रतिक्रियाएँ
202 सफल प्रतिक्रिया
application/json
object
idstring · uuidस्थिति की जांच करने और लंबित सबमिशन को रद्द करने के लिए ऑपरेशन आईडी।
kindstringmailbox_id- विकल्प 1
integerविकल्प 2null statusstringमान्य मान:
"queued""running""succeeded""failed""uncertain""cancelled"run_atstringUTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है
created_atstringUTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है
completed_at- विकल्प 1
stringUTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है
विकल्प 2null errorयदि ऑपरेशन सफलतापूर्वक पूरा नहीं हुआ तो त्रुटि का कारण।
विकल्प 1stringविकल्प 2nullresultऑपरेशन का नतीजा. भेजने के लिए, स्वीकृत और अस्वीकृत प्राप्तकर्ताओं के बारे में जानकारी शामिल है।
विकल्प 1objectविकल्प 2null
400 अमान्य शीर्षलेख या पहचानकर्ता
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
401 लॉगिन आवश्यक है
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
403 तक पहुँच नहीं
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
404 संसाधन नहीं मिला
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
409 राज्य संघर्ष
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
413 आकार से अधिक हो गया
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
422 सत्यापन त्रुटि
application/json
object
detailarrayसरणी तत्वobjectlocअनिवार्य रूप सेarrayसरणी तत्वविकल्प 1stringविकल्प 2integermsgअनिवार्य रूप सेstringtypeअनिवार्य रूप सेstring
503 अस्थायी अनुपलब्धता
application/json
object
detail- विकल्प 1
stringविकल्प 2objectcodestringmessagestring
विकल्प 3arrayसरणी तत्वobject
सफल प्रस्तुतिकरण परिणाम
ऑपरेशन के result फ़ील्ड निष्पादन के बाद हैं, कतारबद्ध होने की प्रतिक्रिया नहीं।
object
message_idstringsmtp_acceptedbooleansent_savedbooleanaccepted_recipientsarrayसरणी तत्वstringrejected_recipientsarrayसरणी तत्वobjectemailstringcodeinteger