# Adapt Mail API 0.16.0 https://adapt-mail.com/hi/docs/ # दस्तावेज़ीकरण Adapt Mail ## अपने उत्पाद के लिए मेल करें अपने इंटरफ़ेस को Adapt Mail: मेलबॉक्स से कनेक्ट करें, पत्र पढ़ें और भेजें, संवाद दिखाएं, फ़ाइलें, संपर्क और प्रेषक नियम प्रबंधित करें। खाते बनाएं, डोमेन कनेक्ट करें, मेलबॉक्स के लिए भुगतान करें और अपने व्यक्तिगत खाते में जहां आपने अपना मेल कनेक्ट किया है, उनकी मात्रा बढ़ाएं। मेल API आपको पहले से बनाए गए मेलबॉक्स के साथ काम करने की अनुमति देता है। ## प्राधिकरण से प्रारंभ करें सर्वर एकीकरण के लिए, X-Customer-ID. के साथ मेल API-कुंजी का उपयोग करें। किसी विशिष्ट उपयोगकर्ता के लिए लॉग इन करने के लिए, उसके लॉगिन और पासवर्ड का उपयोग करके Bearer-टोकन प्राप्त करें। ``` GET /v1/mailboxes X-API-Key: X-Customer-ID: ``` ## पहला अनुरोध आधार पता API - https://adapt-mail.com. सभी अनुरोध HTTPS. के माध्यम से संसाधित किए जाते हैं JSON- अनुरोधों के लिए कृपया Content-Type: application/json. इंगित करें अपने ईमेल खाते के लॉगिन और पासवर्ड का उपयोग करके टोकन प्राप्त करें। फिर मेलबॉक्सों की एक सूची का अनुरोध करें और वांछित मेलबॉक्स के id को संग्रहीत करें: इसका उपयोग अनुरोध पतों में mailbox_id के रूप में किया जाता है। कोण कोष्ठक में मानों को अपने डेटा से बदलें। ``` curl https://adapt-mail.com/v1/auth/token \ -H "Content-Type: application/json" \ --data '{"login":"","password":"","mode":"account"}' curl https://adapt-mail.com/v1/mailboxes \ -H "Authorization: Bearer " ``` ## दस्तावेज़ीकरण प्रारूप OpenAPI स्कीमा अनुरोध पैरामीटर और प्रतिक्रियाओं का वर्णन करती है। फ़ाइल llms-full.txt में पाठ प्रारूप में संपूर्ण संदर्भ पुस्तक शामिल है। डाउनलोड लिंक प्रत्येक पृष्ठ की शुरुआत में उपलब्ध हैं। # प्राधिकरण और पहुंच क्षेत्र ## लिंक से साइन इन आपका सर्वर X-API-Key और X-Customer-ID के साथ POST /v1/auth/login-link को कॉल करता है। केवल एक मेलबॉक्स खोलने के लिए mailbox_id दें; पूरा खाता खोलने के लिए इसे छोड़ दें। locale इंटरफ़ेस की भाषा चुनता है। जवाब में login_url, expires_in=300, expires_at (UTC), account_id और mailbox_id मिलते हैं। “मेल खोलें” बटन #token सहित पूरा login_url खोलता है। लिंक 5 मिनट तक और केवल एक बार मान्य है। इसे लॉग में न लिखें और API कुंजी ब्राउज़र में उजागर न करें। साइन इन पृष्ठ पता बार से टोकन हटा देता है और उसके बदले HttpOnly कुकीज़ प्राप्त करता है। त्रुटि या समय सीमा समाप्त होने पर नया लिंक बनाएँ। पहुँच का दायरा तथा खाते और मेलबॉक्स की स्थिति दोबारा जाँची जाती है। उपयोगकर्ता सत्र लिंक नहीं बना सकते। ``` curl https://adapt-mail.com/v1/auth/login-link \ -H "X-API-Key: " \ -H "X-Customer-ID: " \ -H "Content-Type: application/json" \ --data '{"mailbox_id":42,"locale":"en"}' { "login_url": "https://adapt-mail.com/auth/#token=", "expires_in": 300, "expires_at": "2026-10-20T12:05:00Z", "account_id": 123, "mailbox_id": 42 } ``` ## साझेदार कुंजी अपने एकीकरण की मेल API-कुंजी का उपयोग करें। इसे X-API-Key और मेल खाते के ID को भेजें - आवश्यक हेडर X-Customer-ID. में यह खाते का ID है, न कि external_id और मेलबॉक्स का ID नहीं। कुंजी केवल आपके एकीकरण के ग्राहकों तक पहुंच की अनुमति देती है। कुंजी को अपने भागीदार के सर्वर पर संग्रहीत करें. साझा एकीकरण कुंजी को ब्राउज़र या मोबाइल एप्लिकेशन में न रखें। ``` curl 'https://adapt-mail.com/v1/mailboxes' \ -H 'X-API-Key: ' \ -H 'X-Customer-ID: ' ``` ## उपयोगकर्ता टोकन POST /v1/auth/token login, password और mode. स्वीकार करता है mode=account के लिए लॉगिन user-ID का उपयोग किया जाता है, mode=mailbox के लिए पूर्ण मेलबॉक्स पता का उपयोग किया जाता है। खाता और मेलबॉक्स पासवर्ड स्वतंत्र हैं. प्रतिक्रिया में access_token, token_type=Bearer और expires_in=3600. शामिल हैं खाता टोकन अपने बॉक्स खोलता है; बॉक्स टोकन - केवल एक बॉक्स। समाप्ति के बाद, आपको एक नया टोकन प्राप्त होगा। ``` POST /v1/auth/token Content-Type: application/json {"login":"user-123","password":"","mode":"account"} GET /v1/mailboxes Authorization: Bearer ``` ## ब्राउज़र सत्र POST /v1/auth/login अपनी साइट के लिए है adapt-mail.com. इसके लिए सही Origin की आवश्यकता होती है और HttpOnly cookies. इंस्टॉल होता है। अवर्गीकृत X-Mail-Session सहेजे गए इनपुट में से एक का चयन करता है, लेकिन cookie के बिना एक्सेस नहीं देता है। तृतीय-पक्ष फ़्रंटएंड के लिए, अपने सर्वर और उपयोगकर्ता टोकन का उपयोग करें। किसी भी साइट नंबर के लिए cookie: सार्वजनिक CORS से यादृच्छिक क्रॉस-डोमेन एक्सेस पर भरोसा न करें। # प्रेषण एवं संचालन ## एक पत्र कतारबद्ध करें GET /v1/mailboxes. से ID बॉक्स प्राप्त करें एक सबमिशन के लिए एक अद्वितीय Idempotency-Key बनाएं और इसे अंतिम परिणाम तक सहेजें। नेटवर्क रीप्ले के लिए, समान कुंजी और समान बॉडी का उपयोग करें। HTTP 202 एक ऑपरेशन ऑब्जेक्ट लौटाता है, डिलीवरी पुष्टिकरण नहीं। फ़ील्ड id में ID ऑपरेशन शामिल हैं। पोल GET /v1/operations/{operation_id}. ``` POST /v1/mailboxes/42/send Idempotency-Key: message-20261019-0001 Content-Type: application/json {"to":["team@example.com"],"subject":"Hello","text":"A message from Adapt Mail"} ``` ## परिणाम को कैसे समझें - `queued` — पत्र भेजे जाने की प्रतीक्षा की जा रही है. - `running` — भेजने का कार्य प्रगति पर है. - `succeeded` — मेल सर्वर ने सबमिशन स्वीकार कर लिया. प्रत्येक प्राप्तकर्ता के लिए परिणाम की जाँच करें. - `failed` — भेजना विफल रहा. कारण error. में दिया गया है - `cancelled` — प्रेषण रद्द कर दिया गया. - `uncertain` — भेजे गए परिणाम की पुष्टि करने में विफल. कृपया दोबारा प्रयास करने से पहले ऑपरेशन और अपने भेजे गए फ़ोल्डर की जांच करें। सफल प्रेषण के बाद, result फ़ील्ड में accepted_recipients - स्वीकृत प्राप्तकर्ता, rejected_recipients - अस्वीकृत प्राप्तकर्ता और sent_saved - भेजे गए में एक प्रति सहेजने का परिणाम शामिल होता है। मेल सर्वर द्वारा किसी पत्र की स्वीकृति प्राप्तकर्ता के इनबॉक्स में डिलीवरी की गारंटी नहीं देती है। किसी लंबित प्रेषण को रद्द करने के लिए, POST /v1/operations/{operation_id}/cancel. चलाएँ /retry विधि ईमेल को दोबारा नहीं भेजती है। ## उत्तर, अग्रेषित और विलंबित प्रेषण उत्तर देने के लिए, कृपया reply_to_message_id में मूल ईमेल का message_id शामिल करें और इसे references. पर अग्रेषित करें to में, reply_to से उत्तर पता या प्रेषक का पता दर्ज करें। सभी को उत्तर देने के लिए, अपने पते को छोड़कर, अन्य प्रतिभागियों को to और cc में जोड़ें। अनुलग्नकों को अग्रेषित करने के लिए, folder, uidvalidity और uid. के साथ forward_message पास करें। अपनी अपलोड की गई फ़ाइलों के लिए, file_ids. का उपयोग करें। कुल अनुलग्नक का आकार 25 MiB तक सीमित है। send_at को एक समय क्षेत्र के साथ निर्दिष्ट किया जाता है, जिसे UTC में संग्रहीत किया जाता है; विलंबित शिपिंग एक वर्ष के भीतर उपलब्ध है। सीमाएँ वास्तविक भेजने पर जाँची जाती हैं, कतार निर्माण पर नहीं। # SMTP से ईमेल भेजना ## कनेक्ट करने से पहले अपने एप्लिकेशन से SMTP के ज़रिए ईमेल भेजने के लिए मेलबॉक्स का यूज़रनेम और पासवर्ड इस्तेमाल करें। SMTP के लिए API कुंजी और अकाउंट टोकन का उपयोग नहीं किया जा सकता। जुड़े हुए डोमेन पर एक सक्रिय मेलबॉक्स बनाएं और उसके DNS रिकॉर्ड का सत्यापन पूरा करें। यूज़रनेम पूरा ईमेल पता होता है, जैसे noreply@example.com। मेल अकाउंट का नहीं, उस मेलबॉक्स का पासवर्ड इस्तेमाल करें। उदाहरणों के पतों को अपने पतों से बदलें; प्रोग्राम चलाते समय पासवर्ड दर्ज किया जाता है और स्क्रीन पर दिखाई नहीं देता। ## सर्वर, पोर्ट और एन्क्रिप्शन किसी भी जुड़े हुए डोमेन के लिए mail.adapt-mail.com इस्तेमाल करें। पोर्ट 465 पर TLS तुरंत शुरू होता है; पोर्ट 587 पर प्रमाणीकरण से पहले STARTTLS होता है। इनमें से एक विकल्प चुनें। प्रमाणपत्र का सत्यापन चालू रखें। उदाहरणों में From पता और SMTP एनवेलप का प्रेषक मेलबॉक्स के यूज़रनेम के समान हैं। प्रेषक का दिखाई देने वाला नाम बदला जा सकता है। पोर्ट 25 मेल सर्वरों के बीच संचार के लिए है; अपने एप्लिकेशन के लिए 465 या 587 इस्तेमाल करें। ``` SMTP_HOST = "mail.adapt-mail.com" SMTP_PORT = 465 SMTP_USER = "noreply@example.com" SMTP_PASSWORD = "" SMTP_FROM = "noreply@example.com" SMTP_FROM_NAME = "Example" 465: implicit TLS 587: STARTTLS ``` ## Python: पोर्ट 465 से भेजना यह उदाहरण केवल Python 3 की मानक लाइब्रेरी का उपयोग करता है। इसे send_mail.py में सहेजें और python3 send_mail.py चलाएं। स्वचालित भेजने के लिए पासवर्ड अपने एप्लिकेशन के सुरक्षित कॉन्फ़िगरेशन से लें; उसे Git या लॉग में न रखें। ``` import smtplib import ssl from getpass import getpass from email.message import EmailMessage from email.utils import formataddr, make_msgid, formatdate username = "noreply@example.com" password = getpass("SMTP password: ") recipient = "recipient@example.net" message = EmailMessage() message["From"] = formataddr(("Example", username)) message["To"] = recipient message["Subject"] = "SMTP test" message["Date"] = formatdate(localtime=False, usegmt=True) message["Message-ID"] = make_msgid(domain=username.split("@")[1]) message.set_content("Hello! This message was sent through Adapt Mail SMTP.") with smtplib.SMTP_SSL( "mail.adapt-mail.com", 465, timeout=30, context=ssl.create_default_context(), ) as smtp: smtp.login(username, password) refused = smtp.send_message( message, from_addr=username, to_addrs=[recipient], ) print("Rejected recipients:", refused) ``` ## Python: पोर्ट 587 से कनेक्ट करना STARTTLS के लिए पिछले उदाहरण में संदेश तैयार करने वाला कोड रखें और with smtplib.SMTP_SSL ब्लॉक को नीचे दिए गए कोड से बदलें। smtplib.SMTP में पासवर्ड STARTTLS सफल होने के बाद ही भेजा जाता है। ``` with smtplib.SMTP("mail.adapt-mail.com", 587, timeout=30) as smtp: smtp.ehlo() smtp.starttls(context=ssl.create_default_context()) smtp.ehlo() smtp.login(username, password) refused = smtp.send_message( message, from_addr=username, to_addrs=[recipient], ) print("Rejected recipients:", refused) ``` ## HTML और अटैचमेंट set_content के बाद HTML संस्करण जोड़ें और भेजने से पहले अटैचमेंट जोड़ें। HTML का समर्थन न करने वाले क्लाइंट के लिए सादा टेक्स्ट संस्करण भी रखें। केवल भरोसेमंद HTML इस्तेमाल करें या जोड़े जाने वाले डेटा को एस्केप करें। ``` message.add_alternative( "

Hello! This message was sent through Adapt Mail.

", subtype="html", ) with open("document.pdf", "rb") as attachment: message.add_attachment( attachment.read(), maintype="application", subtype="pdf", filename="document.pdf", ) ``` ## परिणाम, सीमाएं और भेजे गए संदेश send_message की सफलता का मतलब है कि SMTP सर्वर ने संदेश स्वीकार कर लिया है, न कि वह प्राप्तकर्ता के इनबॉक्स में पहुंच गया है। refused डिक्शनरी में अस्वीकृत प्राप्तकर्ता होते हैं; सभी प्राप्तकर्ता अस्वीकृत होने पर Python SMTPRecipientsRefused अपवाद देता है। SMTP और API हर मेलबॉक्स की समान सीमाएं साझा करते हैं: पिछले 60 सेकंड में अधिकतम 30 संदेश, हर संदेश में 50 प्राप्तकर्ता और पिछले 24 घंटों में 1000 प्राप्तकर्ता; बढ़ी हुई सीमा चालू होने पर 5000 प्राप्तकर्ता। To, Cc और Bcc के सभी प्राप्तकर्ता गिने जाते हैं। सीधे SMTP से भेजने पर भेजे गए संदेशों के फ़ोल्डर में अपने आप कॉपी नहीं बनती। मेल क्लाइंट यह काम IMAP से करते हैं; Adapt Mail API से भेजने पर कॉपी अलग से सहेजी जाती है। ## SMTP त्रुटियां - `535` — प्रमाणीकरण विफल: पूरा पता, मेलबॉक्स का पासवर्ड और मेलबॉक्स की उपलब्धता जांचें। - `451` — अस्थायी विफलता, जिसमें भेजने की सीमा पार होना भी शामिल है। कुछ देर बाद फिर कोशिश करें। - `550 / 5xx` — स्थायी अस्वीकृति: पते, प्रेषक की अनुमतियां और जवाब का विवरण जांचें। 50 से अधिक प्राप्तकर्ता DATA के बाद अस्वीकृत होते हैं। दोबारा कोशिश करने से पहले कारण ठीक करें। - `TLS / timeout` — mail.adapt-mail.com, पोर्ट, TLS मोड और एप्लिकेशन सर्वर से बाहरी कनेक्शन की अनुमति जांचें। 465 पर SMTP_SSL और 587 पर STARTTLS के साथ SMTP इस्तेमाल करें। SMTP सर्वर का पूरा जवाब पढ़ें। अस्थायी विफलता पर कुछ देर बाद फिर कोशिश करें। संदेश भेजने के बाद कनेक्शन टूट जाए और परिणाम पता न हो, तो बिना जांचे दोबारा न भेजें: SMTP में Idempotency-Key नहीं होता और दोबारा कोशिश करने से डुप्लिकेट बन सकता है। # पत्र और संवाद ## सूची और पृष्ठ GET /v1/mailboxes/{mailbox_id}/folders अक्षरों की कुल संख्या total, अपठित अक्षरों की संख्या unread और uidvalidity. के मान वाले फ़ोल्डर लौटाता है। अक्षरों की सूची के लिए GET /v1/mailboxes/{mailbox_id}/messages: का उपयोग करें, प्रतिक्रिया में items, next_before और uidvalidity शामिल हैं, प्रति पृष्ठ 40 अक्षर तक। अगले अनुरोध में next_before को before के रूप में पास करें। null का अर्थ है सूची का अंत। q की खोज 200 अक्षरों तक सीमित है और मेल की सामग्री के आधार पर की जाती है। ``` GET /v1/mailboxes/42/messages?folder=INBOX GET /v1/mailboxes/42/messages?folder=INBOX&before=120 ``` ## पत्र आईडी uid फ़ोल्डर के अंदर अक्षर का पहचानकर्ता है, folder फ़ोल्डर का नाम है, mailbox_id मेलबॉक्स का ID है। मान uidvalidity फ़ोल्डर में अक्षरों का क्रमांकन संस्करण निर्धारित करता है। उत्तर API से सभी चार मान लें और उन्हें एक साथ संग्रहीत करें। यदि uidvalidity बदल गया है, तो इस फ़ोल्डर के लिए मेल सूची दोबारा डाउनलोड करें: पुराने uid का अब उपयोग नहीं किया जा सकता है। सामग्री को पढ़ने से ईमेल को पढ़ा गया के रूप में चिह्नित नहीं किया जाता है। चिह्नित करने के लिए, action=read. के साथ POST /v1/mailboxes/{mailbox_id}/messages/actions करें ``` POST /v1/mailboxes/42/messages/actions {"folder":"INBOX","uidvalidity":123456,"uids":[120],"action":"read"} ``` ## संवाद के रूप में पत्राचार GET /v1/mailboxes/{mailbox_id}/threads 100 संवाद तक लौटाता है। इसके अक्षरों को पुराने से नए में लाने के लिए चयनित वार्तालाप के thread_id को GET /v1/mailboxes/{mailbox_id}/threads/{thread_id} पर पास करें। बातचीत में कोई नया पत्र थोड़े विलंब से सामने आ सकता है। सूची अद्यतन करें; सबमिशन की जांच करने के लिए, ऑपरेशन स्थिति का उपयोग करें। प्रदर्शन में देरी के कारण ईमेल को दोबारा भेजने की कोई आवश्यकता नहीं है। # सीमाएँ और भंडारण ## सामान्य सीमाएँ SMTP और API नियमित मेलबॉक्स: 24 घंटे की अवधि में 1000 प्राप्तकर्ता। outbound_high_limit=true: 5000 के साथ बॉक्स। 60 सेकंड की स्लाइडिंग में 30 अक्षरों तक; एक पत्र के To, Cc और Bcc में कुल 50 प्राप्तकर्ता तक। प्राप्त SMTP-प्राप्तकर्ताओं को ध्यान में रखा जाता है, जिसमें विभिन्न पत्रों में प्राप्तकर्ताओं के आंतरिक पते और दोहराव शामिल हैं। घंटे की कोई अलग सीमा नहीं है. यह अनुमतियाँ भेजने की खपत है, न कि वितरित पत्रों के आँकड़े। GET /v1/mailboxes दोनों विंडो की सीमा, प्रवाह और शेष लौटाता है। प्रति पत्र प्राप्तकर्ताओं की सीमा के लिए कोई संचयी व्यय नहीं है। यदि मीटर अनुपलब्ध है, तो सर्वर शून्य खपत के बजाय 503 लौटाता है। ``` { "outbound_daily_recipient_limit": 1000, "outbound_daily_recipients_used": 120, "outbound_daily_recipients_remaining": 880, "outbound_messages_per_minute": 30, "outbound_minute_messages_used": 2, "outbound_minute_messages_remaining": 28, "outbound_recipients_per_message": 50 } ``` ## सीमा से अधिक API-भेजें 202 प्राप्त कर सकते हैं और बाद में failed mail_daily_limit_exceeded या mail_minute_limit_exceeded. के साथ विफल हो सकते हैं 50 से अधिक प्राप्तकर्ता 422 के साथ तुरंत अस्वीकार कर दिए जाते हैं। SMTP विंडो पार होने पर 451 की अस्थायी विफलता लौटाता है और 50 से अधिक प्राप्तकर्ता होने पर DATA के बाद 550 देता है। किसी अन्य प्रोटोकॉल के माध्यम से सीमा को बायपास करने का कोई तरीका नहीं है। ## मेल और फ़ाइलें quota_mb ईमेल और फ़ाइलों की साझा क्षमता है, MiB में। used_bytes कुल उपयोग है, बाइट में। storage_shared=true; file_quota_bytes, quota_mb × 1048576 के बराबर है और अतिरिक्त क्षमता नहीं है। file_used_bytes अपलोड की गई फ़ाइलों का मूल आकार है, जो कुल उपयोग में पहले से शामिल है। फ़ाइलें ईमेल के साथ हमारी डिस्क पर रखी जाती हैं। साझा कोटे में MIME एन्कोडिंग और हेडर शामिल हैं। भेजे गए ईमेल में अटैचमेंट की कॉपी अतिरिक्त जगह लेती है। बाहरी IMAP क्लाइंट में Adapt Files सिस्टम फ़ोल्डर दिखाई देता है: इसे हटाने से सहेजी गई फ़ाइलें भी हट जाती हैं। नवीनीकरण और वॉल्यूम में वृद्धि आपके व्यक्तिगत खाते में उपलब्ध है जहां आपने अपना ईमेल कनेक्ट किया है। भुगतान अवधि समाप्त होने के बाद, पढ़ना और भेजना अवरुद्ध हो जाता है। 24 घंटों के बाद, बॉक्स को हटाना शुरू हो जाता है; इस तिथि से पहले अपनी सदस्यता नवीनीकृत करें। # घटनाएँ और वेबहुक ## वेबहुक कनेक्ट करना अपनी एकीकरण सेटिंग में वेबहुक प्राप्त करने का पता निर्दिष्ट करें। यह नए पत्रों, मेलबॉक्सों की स्थिति और संचालन के परिणामों के बारे में सूचनाएं प्राप्त करेगा। एकीकरण सेटिंग्स में, एक अलग वेबहुक रहस्य सेट करें और डिलीवरी सक्षम करें। इस रहस्य का उपयोग अधिसूचना हस्ताक्षरों को सत्यापित करने के लिए किया जाता है; मेल API-key इसके लिए उपयुक्त नहीं है। ## अधिसूचना प्रारूप अधिसूचना HTTP POST- अनुरोध के साथ Content-Type: application/json. फ़ील्ड event में इवेंट प्रकार, timestamp - अधिसूचना समय, data - इवेंट डेटा आता है। data की संरचना घटना पर निर्भर करती है। पहचानकर्ता data.event_id आपको पुनः डिलीवरी को पहचानने की अनुमति देता है। इसे अपनी एकीकरण आईडी के साथ संग्रहीत करें और एक ईवेंट को केवल एक बार संसाधित करें। ``` { "event": "mail.message.received", "timestamp": "2026-11-01T12:00:00Z", "data": { "event_id": "00000000-0000-4000-8000-000000000001", "created_at": "2026-11-01T12:00:00Z", "mailbox_id": 42, "folder": "INBOX", "uidvalidity": 123456, "uid": 120 } } ``` ## सत्यापन एवं पुष्टि हेडर X-Webhook-Signature में लोअरकेस हेक्साडेसिमल नोटेशन में HMAC-SHA256 शामिल है। अनुरोध निकाय के मूल बाइट्स और वेबहुक रहस्य से हस्ताक्षर की गणना करें। डेटा संसाधित करने से पहले हस्ताक्षर की जाँच करें; JSON को पुनः क्रमबद्ध करने से हस्ताक्षरित बाइट्स बदल जाएंगे। हस्ताक्षर सत्यापित करने और ईवेंट सहेजने के बाद, HTTP 200 या 201 लौटाएँ। प्रतिक्रियाएँ 202 और 204 रसीद स्वीकार नहीं करते हैं। 10 सेकंड के भीतर उत्तर दें; ईवेंट सहेजने के बाद लंबी प्रोसेसिंग करें. सूचनाएं बार-बार आ सकती हैं और क्रम से बाहर हो सकती हैं। सदस्यता स्थिति बदलने से पहले, उसके वर्तमान विवरण की जाँच करें। डिलीवरी इतिहास एकीकरण सेटिंग्स में उपलब्ध है। ## क्या घटनाएँ घटित होती हैं - `mailbox.created` — बॉक्स बन गया है और उपयोग के लिए तैयार है। - `mailbox.expiring` — बॉक्स के लिए भुगतान अवधि की समाप्ति निकट आ रही है। - `mailbox.renewed` — बॉक्स के लिए भुगतान की अवधि बढ़ा दी गई है। - `mailbox.suspended` — मेलबॉक्स तक पहुंच निलंबित है: पढ़ना और भेजना अनुपलब्ध है। - `mailbox.resumed` — मेलबॉक्स तक पहुंच बहाल कर दी गई है. - `mailbox.deleting_soon` — अवैतनिक बॉक्स हटाए जाने में एक घंटा शेष है। - `mailbox.deleted` — बॉक्स हटा दिया गया है. - `mailbox.account_changed` — मेलबॉक्स दूसरे मेल खाते से जुड़ा हुआ है। - `mail.message.received` — मेलबॉक्स में एक नया आवक पत्र सामने आया है। - `mail.operation.succeeded` — ऑपरेशन सफलतापूर्वक पूरा हुआ. भेजने के लिए, इसका मतलब प्राप्तकर्ता के इनबॉक्स में डिलीवरी के बजाय मेल सर्वर द्वारा पत्र की स्वीकृति है। - `mail.operation.failed` — ऑपरेशन विफल रहा. - `mail.operation.uncertain` — भेजने का परिणाम अज्ञात है. कृपया पुनः भेजने से पहले स्थिति की जांच कर लें। भुगतान अनुस्मारक: 14, 7, 3, 2, 1 दिन और समाप्ति से एक घंटा पहले। नवीनीकरण उन पुराने अनुस्मारक को रद्द कर देता है जिन्हें अभी तक नहीं भेजा गया है। # त्रुटियाँ और दोहराव ## त्रुटि स्वरूप त्रुटि प्रतिक्रिया में एक detail: स्ट्रिंग, code/message वाला एक ऑब्जेक्ट या सत्यापन त्रुटियों की एक सूची शामिल है। अनूदित पाठ से व्यवहार का निर्धारण न करें: मौजूद होने पर HTTP-status और मशीन-जनरेटेड code का उपयोग करें। ``` {"detail":"..."} {"detail":{"code":"...","message":"..."}} ``` ## कोड HTTP - `400` — अमान्य शीर्षलेख या पहचानकर्ता. अपना अनुरोध जांचें. - `401` — सत्र या कुंजी स्वीकार नहीं की गई. दोबारा साइन इन करें या अपनी कुंजी जांचें। - `403` — अपर्याप्त अधिकार या मेलबॉक्स तक पहुंच से इनकार कर दिया गया है। - `404` — संसाधन नहीं मिला या चालू खाते में उपलब्ध नहीं है। - `409` — फ़ोल्डर स्थिति, कोटा, या पीढ़ी विरोध. कृपया पुनः प्रयास करने से पहले अपना डेटा अपडेट करें। - `413` — फ़ाइल का आकार अनुमत सीमा से अधिक है. - `422` — अमान्य अनुरोध पैरामीटर. प्रतिक्रिया में दिए गए फ़ील्ड की जाँच करें. - `429` — बहुत सारे अनुरोध. कृपया बाद में पुन: प्रयास करें। - `503` — सेवा अस्थायी रूप से अनुपलब्ध है. विलंब से अनुरोध पुनः प्रयास करें. 401 के बाद, एक नया लॉगिन आवश्यक है। 409 के बाद स्थिति को दोबारा पढ़ें। 503 के बाद, देरी से दोहराएं; भेजने के लिए, वही रखें Idempotency-Key. अपरिवर्तनीय कार्यों को आँख बंद करके न दोहराएं। # कनेक्ट किए गए ऐप ## ऐप कनेक्ट करें इस पते से अपना AI क्लाइंट कनेक्ट करें। कनेक्ट करते समय मेलबॉक्स और अनुमतियाँ चुनें। केवल आवश्यक मेलबॉक्स और कार्रवाइयों की अनुमति दें। ``` URL / Resource: https://adapt-mail.com/mcp Transport: Streamable HTTP Authorization: OAuth 2.1 / PKCE S256 OAuth discovery: /.well-known/oauth-authorization-server Resource metadata: /.well-known/oauth-protected-resource/mcp ``` ## अनुमतियाँ - `mail.read` — संदेश, बातचीत और अटैचमेंट खोजना और पढ़ना। - `mail.send` — संदेश भेजना, जवाब देना और आगे भेजना। - `mail.manage` — ड्राफ़्ट, फ़ाइलें, फ़ोल्डर, पढ़ने की स्थिति, महत्वपूर्ण संदेश, संग्रह और स्पैम। - `mail.delete` — ट्रैश और संदेशों, ड्राफ़्ट व फ़ाइलों को स्थायी रूप से हटाना। ## पहुँच रद्द करें पहुँच 30 दिनों तक रहती है। आप इसे सेटिंग में कभी भी रद्द कर सकते हैं। # मेलबॉक्स सेटिंग्स ## ईमेल टेम्पलेट प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता। टेम्पलेट संपादक के टेक्स्ट को बदल देगा। प्राप्तकर्ता और अटैचमेंट बने रहेंगे। ``` POST /v1/mailboxes/42/templates Content-Type: application/json {"name":"Welcome","subject":"Welcome","text":"Thank you for joining us.","html":"

Thank you for joining us.

"} ``` ## स्वचालित उत्तर ब्राउज़र बंद होने पर भी स्वचालित उत्तर भेजे जाते हैं और वे भेजने की सीमा में गिने जाते हैं। मेलिंग सूची और स्वचालित संदेशों को उत्तर नहीं दिया जाता। स्वचालित उत्तर की तारीखों में समय क्षेत्र दें; repeat_days 1 से 30 तक है। केवल नए व्यक्तिगत संदेशों का उत्तर दिया जाता है: From और Return-Path का मेल होना चाहिए। ``` PUT /v1/mailboxes/42/autoresponder Content-Type: application/json {"enabled":true,"subject":"Away","text":"I will reply when I return.","starts_at":null,"ends_at":null,"repeat_days":7} ``` ## फ़िल्टर प्रति मेलबॉक्स अधिकतम 100 फ़िल्टर और प्रति फ़िल्टर 20 शर्तें। पूरे हेडर की तुलना होती है; ASCII में बड़े-छोटे अक्षरों का अंतर नहीं माना जाता, अन्य वर्णों में माना जाता है। पहला मेल खाने वाला फ़िल्टर लागू होता है। प्रेषक के नियमों को प्राथमिकता मिलती है। पुराने संदेशों पर अलग से लागू करें। फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें। इनबॉक्स और आपके फ़ोल्डर संसाधित होंगे। भेजे गए संदेश, ड्राफ़्ट, स्पैम और ट्रैश शामिल नहीं हैं। ``` POST /v1/mailboxes/42/filters Content-Type: application/json {"name":"Invoices","enabled":true,"match":"all","conditions":[{"field":"subject","operator":"contains","value":"Invoice"}],"mark_read":false,"important":true,"trash":false,"move_to":null} POST /v1/mailboxes/42/filters/17/apply Idempotency-Key: apply-filter-0001 ``` ## पूर्व दर्शन - `file_infected` — खतरा मिला है। इस फ़ाइल को खोलना रोक दिया गया है। - `file_scan_unavailable` — एंटीवायरस अभी उपलब्ध नहीं है। बाद में फिर कोशिश करें। DOC, XLS, XLSX, PPT, PPTX और ODT की फ़ाइल या अटैचमेंट सामग्री के अनुरोध में preview=pdf जोड़ें। सीमा: प्रति मेलबॉक्स प्रति मिनट 10 रूपांतरण। X-File-Scan: clean और X-File-Scanned-At जाँच का परिणाम और समय बताते हैं। फ़ाइल सूची में scanned_at null हो सकता है। परिणाम एक घंटे तक कैश होता है; खतरा मिलने या एंटीवायरस अनुपलब्ध होने पर फ़ाइल नहीं दी जाती। ``` GET /v1/mailboxes/42/files//content?preview=pdf X-File-Scan: clean X-File-Scanned-At: 2026-10-22T12:00:00Z ``` # POST /v1/auth/login ब्राउज़र में लॉग इन करें मार्ग adapt-mail.com के लिए है और आपके ग्राहक उपयोग के लिए Origin: https://adapt-mail.com. रिटर्न HttpOnly cookies और अवर्गीकृत session_id. की आवश्यकता है /v1/auth/token. ```sh curl -X POST 'https://adapt-mail.com/v1/auth/login' \ -H 'Origin: https://adapt-mail.com' \ -c cookies.txt \ -H 'Content-Type: application/json' \ --data '{"login":"user-123","password":""}' ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "ब्राउज़र में लॉग इन करें", "operationId": "login_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "session_id": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "बहुत सारे अनुरोध", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "मार्ग adapt-mail.com के लिए है और आपके ग्राहक उपयोग के लिए Origin: https://adapt-mail.com. रिटर्न HttpOnly cookies और अवर्गीकृत session_id. की आवश्यकता है /v1/auth/token.", "security": [] } ``` # POST /v1/auth/token उपयोगकर्ता टोकन प्राप्त करना लॉगिन और पासवर्ड के आधार पर एक घंटे के लिए एक्सेस टोकन जारी करता है। सभी खाता मेलबॉक्सों तक पहुँचने के लिए mode=account या एक पते तक पहुँचने के लिए mode=mailbox निर्दिष्ट करें। Authorization: Bearer हेडर में access_token पास करें। ```sh curl -X POST 'https://adapt-mail.com/v1/auth/token' \ -H 'Content-Type: application/json' \ --data '{"login":"user-123","password":""}' ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "उपयोगकर्ता टोकन प्राप्त करना", "operationId": "token_v1_auth_token_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "const": "Bearer" }, "expires_in": { "type": "integer", "const": 3600 }, "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "बहुत सारे अनुरोध", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "लॉगिन और पासवर्ड के आधार पर एक घंटे के लिए एक्सेस टोकन जारी करता है। सभी खाता मेलबॉक्सों तक पहुँचने के लिए mode=account या एक पते तक पहुँचने के लिए mode=mailbox निर्दिष्ट करें। Authorization: Bearer हेडर में access_token पास करें।", "security": [] } ``` # GET /v1/auth/sessions सहेजे गए सत्र आवश्यक cookie mail_browser. X-API-Key और Bearer इसे प्रतिस्थापित न करें cookie. cookie के बिना एक खाली सूची लौटा दी जाती है। ```sh curl -X GET 'https://adapt-mail.com/v1/auth/sessions' \ -b cookies.txt ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "सहेजे गए सत्र", "operationId": "sessions_v1_auth_sessions_get", "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "session_id": { "type": "string" }, "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "login": { "type": "string" }, "name": { "type": "string" } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "आवश्यक cookie mail_browser. X-API-Key और Bearer इसे प्रतिस्थापित न करें cookie. cookie के बिना एक खाली सूची लौटा दी जाती है।", "security": [ { "Browser": [] } ] } ``` # POST /v1/auth/logout सत्र से लॉगआउट करें केवल उपयोगकर्ता सत्र. चयनित इनपुट को याद करता है; शेष इनपुट बरकरार रखे गए हैं। ```sh curl -X POST 'https://adapt-mail.com/v1/auth/logout' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "सत्र से लॉगआउट करें", "operationId": "logout_v1_auth_logout_post", "security": [ { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "logged_out": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "केवल उपयोगकर्ता सत्र. चयनित इनपुट को याद करता है; शेष इनपुट बरकरार रखे गए हैं।" } ``` # GET /v1/me उपयोगकर्ता रूपरेखा वर्तमान मेल खाते की प्रोफ़ाइल लौटाता है. अपने एप्लिकेशन में उपयोगकर्ता नाम प्रदर्शित करने और लॉगिन करने के लिए इसका उपयोग करें। ```sh curl -X GET 'https://adapt-mail.com/v1/me' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "उपयोगकर्ता रूपरेखा", "operationId": "me_v1_me_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "verified": { "type": "boolean" }, "quota_mb": { "type": "integer" }, "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "auth_type": { "type": "string" }, "login": { "type": "string" }, "is_admin": { "type": "boolean" }, "files_enabled": { "type": "boolean" }, "service_managed": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "वर्तमान मेल खाते की प्रोफ़ाइल लौटाता है. अपने एप्लिकेशन में उपयोगकर्ता नाम प्रदर्शित करने और लॉगिन करने के लिए इसका उपयोग करें।" } ``` # GET /v1/avatars/{domain} डोमेन लोगो 200 - छवि; 202 - तैयारी, Retry-After के बाद दोहराएँ; 204 - कोई लोगो नहीं; 503 - अस्थायी त्रुटि. लोगो प्रेषक की पहचान की पुष्टि नहीं करता. ```sh curl -X GET 'https://adapt-mail.com/v1/avatars/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Логотипы доменов" ], "summary": "डोमेन लोगो", "operationId": "avatar_v1_avatars__domain__get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "202": { "description": "लोगो तैयार किया जा रहा है" }, "204": { "description": "कोई लोगो नहीं" }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "बहुत सारे अनुरोध", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "200 - छवि; 202 - तैयारी, Retry-After के बाद दोहराएँ; 204 - कोई लोगो नहीं; 503 - अस्थायी त्रुटि. लोगो प्रेषक की पहचान की पुष्टि नहीं करता." } ``` # GET /v1/domains डोमेन की सूची व्यक्तिगत पता बनाने के लिए कस्टम डोमेन और एक साझा डोमेन उपलब्ध हैं। ```sh curl -X GET 'https://adapt-mail.com/v1/domains' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Домены и ящики" ], "summary": "डोमेन की सूची", "operationId": "list_domains_v1_domains_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "व्यक्तिगत पता बनाने के लिए कस्टम डोमेन और एक साझा डोमेन उपलब्ध हैं।" } ``` # GET /v1/domains/{domain_id}/dns DNS-डोमेन रिकॉर्ड निर्देशों में सटीक DNS- मान और परीक्षण परिणाम शामिल हैं, लेकिन स्वचालित रूप से DNS नहीं बदलते हैं। ```sh curl -X GET 'https://adapt-mail.com/v1/domains//dns' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Домены и ящики" ], "summary": "DNS-डोमेन रिकॉर्ड", "operationId": "domain_dns_v1_domains__domain_id__dns_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Domain Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_id": { "type": "integer" }, "status": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "observed": { "type": "array", "items": { "type": "string" } }, "matches": { "type": "boolean" }, "error": { "type": "string" } } } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "निर्देशों में सटीक DNS- मान और परीक्षण परिणाम शामिल हैं, लेकिन स्वचालित रूप से DNS नहीं बदलते हैं।" } ``` # GET /v1/mailboxes बक्सों की सूची और खपत की सीमा मेलबॉक्सों की सूची स्वामी या उपयोगकर्ता सत्र के एकमात्र मेलबॉक्स द्वारा सीमित है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Домены и ящики" ], "summary": "बक्सों की सूची और खपत की सीमा", "operationId": "list_mailboxes_v1_mailboxes_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Mailbox" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "मेलबॉक्सों की सूची स्वामी या उपयोगकर्ता सत्र के एकमात्र मेलबॉक्स द्वारा सीमित है।" } ``` # PATCH /v1/mailboxes/{mailbox_id} मेलबॉक्स सेटिंग्स /v1 से name, password और signature बदलें। साझा quota_mb को होस्टिंग पैनल से बदलें। फ़ाइलों का अलग कोटा नहीं है। Idempotency-Key वैकल्पिक है, लेकिन दोबारा अनुरोध करने पर इसे उपयोग करना बेहतर है। ```sh curl -X PATCH 'https://adapt-mail.com/v1/mailboxes/' \ -H 'Authorization: Bearer ' \ -H 'Idempotency-Key: message-20261019-0001' \ -H 'Content-Type: application/json' \ --data '{"name":"Support","signature":"Support team"}' ``` ```json { "tags": [ "Домены и ящики" ], "summary": "मेलबॉक्स सेटिंग्स", "operationId": "update_mailbox_v1_mailboxes__mailbox_id__patch", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } }, { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxUpdate" } } } }, "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "400": { "description": "अमान्य शीर्षलेख या पहचानकर्ता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "/v1 से name, password और signature बदलें। साझा quota_mb को होस्टिंग पैनल से बदलें। फ़ाइलों का अलग कोटा नहीं है। Idempotency-Key वैकल्पिक है, लेकिन दोबारा अनुरोध करने पर इसे उपयोग करना बेहतर है।" } ``` # GET /v1/mailboxes/{mailbox_id}/folders फ़ोल्डर्स और काउंटर फ़ोल्डरों की सूची, ईमेल की संख्या total, अपठित संदेशों की संख्या unread और प्रत्येक फ़ोल्डर के लिए मान uidvalidity लौटाता है। इसके अक्षरों की क्वेरी में फ़ोल्डर नाम और uidvalidity का उपयोग करें। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//folders' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "फ़ोल्डर्स और काउंटर", "operationId": "folders_v1_mailboxes__mailbox_id__folders_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "flags": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer" }, "unread": { "type": "integer" }, "uidvalidity": { "type": "integer" } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "फ़ोल्डरों की सूची, ईमेल की संख्या total, अपठित संदेशों की संख्या unread और प्रत्येक फ़ोल्डर के लिए मान uidvalidity लौटाता है। इसके अक्षरों की क्वेरी में फ़ोल्डर नाम और uidvalidity का उपयोग करें।" } ``` # POST /v1/mailboxes/{mailbox_id}/folders एक फ़ोल्डर बनाना कस्टम फ़ोल्डर IMAP में बनाया गया है और अन्य मेल क्लाइंट के लिए उपलब्ध है। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//folders' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"name":""}' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "एक फ़ोल्डर बनाना", "operationId": "create_folder_v1_mailboxes__mailbox_id__folders_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameInput" } } } }, "responses": { "201": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "कस्टम फ़ोल्डर IMAP में बनाया गया है और अन्य मेल क्लाइंट के लिए उपलब्ध है।" } ``` # GET /v1/mailboxes/{mailbox_id}/messages पत्रों की सूची नए UID से पुराने तक, 40 अक्षरों तक रिटर्न देता है। अगले पेज के लिए, next_before को before. के रूप में पास करें, next_before=null के लिए और कोई पेज नहीं है। पढ़ें, पढ़ने का ध्वज सेट नहीं करता है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//messages' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "पत्रों की सूची", "operationId": "messages_v1_mailboxes__mailbox_id__messages_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "folder", "in": "query", "required": false, "schema": { "type": "string", "default": "INBOX", "title": "Folder" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Q" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Before" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MessageSummary" } }, "next_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "uidvalidity": { "type": "integer" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "नए UID से पुराने तक, 40 अक्षरों तक रिटर्न देता है। अगले पेज के लिए, next_before को before. के रूप में पास करें, next_before=null के लिए और कोई पेज नहीं है। पढ़ें, पढ़ने का ध्वज सेट नहीं करता है।" } ``` # GET /v1/mailboxes/{mailbox_id}/messages/{uid} ईमेल की सामग्री मेल सूची से folder, uidvalidity और uid भेजें। HTML साफ़ किया गया, बाहरी छवियाँ शामिल नहीं हैं। किसी पत्र को पठित के रूप में चिह्नित करने के लिए, एक अलग कार्रवाई करें read. ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//messages/?uidvalidity=' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "ईमेल की सामग्री", "operationId": "message_v1_mailboxes__mailbox_id__messages__uid__get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "integer", "title": "Uid" } }, { "name": "uidvalidity", "in": "query", "required": true, "schema": { "type": "integer", "title": "Uidvalidity" } }, { "name": "folder", "in": "query", "required": false, "schema": { "type": "string", "default": "INBOX", "title": "Folder" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "मेल सूची से folder, uidvalidity और uid भेजें। HTML साफ़ किया गया, बाहरी छवियाँ शामिल नहीं हैं। किसी पत्र को पठित के रूप में चिह्नित करने के लिए, एक अलग कार्रवाई करें read." } ``` # POST /v1/mailboxes/{mailbox_id}/messages/actions पत्रों के साथ क्रियाएँ एक फ़ोल्डर में चयनित संदेशों पर एक क्रिया लागू करता है। उनकी आईडी को uids पर, फ़ोल्डर का नाम folder पर और उसके uidvalidity. पर action=move पर, लक्ष्य फ़ोल्डर को destination. पर भी निर्दिष्ट करें। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//messages/actions' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"folder":"INBOX","uidvalidity":1,"uids":[1],"action":"read"}' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "पत्रों के साथ क्रियाएँ", "operationId": "action_v1_mailboxes__mailbox_id__messages_actions_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageAction" } } } }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "एक फ़ोल्डर में चयनित संदेशों पर एक क्रिया लागू करता है। उनकी आईडी को uids पर, फ़ोल्डर का नाम folder पर और उसके uidvalidity. पर action=move पर, लक्ष्य फ़ोल्डर को destination. पर भी निर्दिष्ट करें।" } ``` # GET /v1/mailboxes/{mailbox_id}/messages/{uid}/eml EML पर पत्र डाउनलोड करें हेडर और अनुलग्नकों के साथ मूल MIME-बाइट्स लौटाता है। पठनीयता नहीं बदलती. PDF मुद्रण के माध्यम से ब्राउज़र में बनाया जाता है; कोई अलग PDF-मार्ग नहीं है. ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//messages//eml?uidvalidity=' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "EML पर पत्र डाउनलोड करें", "operationId": "export_eml_v1_mailboxes__mailbox_id__messages__uid__eml_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "integer", "title": "Uid" } }, { "name": "uidvalidity", "in": "query", "required": true, "schema": { "type": "integer", "title": "Uidvalidity" } }, { "name": "folder", "in": "query", "required": false, "schema": { "type": "string", "default": "INBOX", "title": "Folder" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "message/rfc822": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "हेडर और अनुलग्नकों के साथ मूल MIME-बाइट्स लौटाता है। पठनीयता नहीं बदलती. PDF मुद्रण के माध्यम से ब्राउज़र में बनाया जाता है; कोई अलग PDF-मार्ग नहीं है." } ``` # GET /v1/mailboxes/{mailbox_id}/messages/{uid}/attachments/{index} अनुलग्नक डाउनलोड करें DOC, XLS, XLSX, PPT, PPTX और ODT की फ़ाइल या अटैचमेंट सामग्री के अनुरोध में preview=pdf जोड़ें। सीमा: प्रति मेलबॉक्स प्रति मिनट 10 रूपांतरण। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//messages//attachments/?uidvalidity=' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "अनुलग्नक डाउनलोड करें", "operationId": "attachment_v1_mailboxes__mailbox_id__messages__uid__attachments__index__get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "uid", "in": "path", "required": true, "schema": { "type": "integer", "title": "Uid" } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "title": "Index" } }, { "name": "uidvalidity", "in": "query", "required": true, "schema": { "type": "integer", "title": "Uidvalidity" } }, { "name": "folder", "in": "query", "required": false, "schema": { "type": "string", "default": "INBOX", "title": "Folder" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } }, { "name": "preview", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pdf" ] } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-File-Scan": { "schema": { "type": "string" } }, "X-File-Scanned-At": { "schema": { "type": "string" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DOC, XLS, XLSX, PPT, PPTX और ODT की फ़ाइल या अटैचमेंट सामग्री के अनुरोध में preview=pdf जोड़ें। सीमा: प्रति मेलबॉक्स प्रति मिनट 10 रूपांतरण।" } ``` # POST /v1/mailboxes/{mailbox_id}/send एक पत्र भेजें आवश्यक Idempotency-Key 8-128 अक्षर। एक ही कुंजी और बॉडी के साथ दोहराने से वही ऑपरेशन वापस आता है; दूसरा निकाय 409 देता है। HTTP 202 का अर्थ है कतार में लगना। ऑपरेशन की स्थिति की जाँच करें, न कि इस तथ्य की कि कोई प्रतिक्रिया प्राप्त हुई थी। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//send' \ -H 'Authorization: Bearer ' \ -H 'Idempotency-Key: message-20261019-0001' \ -H 'Content-Type: application/json' \ --data '{"to":["team@example.com"],"subject":"Hello","text":"A message from Adapt Mail"}' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "एक पत्र भेजें", "operationId": "send_v1_mailboxes__mailbox_id__send_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendInput" } } } }, "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "400": { "description": "अमान्य शीर्षलेख या पहचानकर्ता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "आकार से अधिक हो गया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "आवश्यक Idempotency-Key 8-128 अक्षर। एक ही कुंजी और बॉडी के साथ दोहराने से वही ऑपरेशन वापस आता है; दूसरा निकाय 409 देता है। HTTP 202 का अर्थ है कतार में लगना। ऑपरेशन की स्थिति की जाँच करें, न कि इस तथ्य की कि कोई प्रतिक्रिया प्राप्त हुई थी।" } ``` # GET /v1/operations संचालन की सूची पिछले 100 ऑपरेशन लौटाता है। किसी व्यक्तिगत मेलबॉक्स का एक सत्र केवल उसके संचालन को देखता है। ```sh curl -X GET 'https://adapt-mail.com/v1/operations' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "संचालन की सूची", "operationId": "operations_v1_operations_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "पिछले 100 ऑपरेशन लौटाता है। किसी व्यक्तिगत मेलबॉक्स का एक सत्र केवल उसके संचालन को देखता है।" } ``` # GET /v1/operations/{operation_id} परिचालन स्थिति किसी ऑपरेशन की वर्तमान स्थिति को उसके id. द्वारा लौटाता है जबकि status queued या running के बराबर है, ऑपरेशन पूरा नहीं हुआ है। एक बार पूरा होने पर, सफलता पर result या त्रुटि पर error जांचें। ```sh curl -X GET 'https://adapt-mail.com/v1/operations/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "परिचालन स्थिति", "operationId": "operation_v1_operations__operation_id__get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Operation Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "किसी ऑपरेशन की वर्तमान स्थिति को उसके id. द्वारा लौटाता है जबकि status queued या running के बराबर है, ऑपरेशन पूरा नहीं हुआ है। एक बार पूरा होने पर, सफलता पर result या त्रुटि पर error जांचें।" } ``` # POST /v1/operations/{operation_id}/cancel भेजना रद्द करें जब ऑपरेशन स्थिति में हो तो पत्र भेजना रद्द करना queued. यदि भेजना पहले ही शुरू हो चुका है, पूरा हो चुका है या रद्द कर दिया गया है, तो 409 वापस कर दिया जाता है। इस पद्धति का उपयोग करके आप पहले से भेजे गए पत्र को याद नहीं कर सकते। ```sh curl -X POST 'https://adapt-mail.com/v1/operations//cancel' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "भेजना रद्द करें", "operationId": "cancel_v1_operations__operation_id__cancel_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Operation Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelled": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "जब ऑपरेशन स्थिति में हो तो पत्र भेजना रद्द करना queued. यदि भेजना पहले ही शुरू हो चुका है, पूरा हो चुका है या रद्द कर दिया गया है, तो 409 वापस कर दिया जाता है। इस पद्धति का उपयोग करके आप पहले से भेजे गए पत्र को याद नहीं कर सकते।" } ``` # POST /v1/operations/{operation_id}/retry ऑपरेशन दोहराएँ प्रेषक नियमों का अनुप्रयोग पुनः प्रारंभ होता है: kind=sender_rules, status=failed. इस पद्धति का उपयोग करके पत्र भेजना दोहराया नहीं जा सकता। अनुपयुक्त स्थिति के लिए, 409 लौटा दिया जाता है; इस पद्धति के माध्यम से मेलबॉक्स के निर्माण और कॉन्फ़िगरेशन को दोहराना उपलब्ध नहीं है और 403 लौटाता है। ```sh curl -X POST 'https://adapt-mail.com/v1/operations//retry' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "ऑपरेशन दोहराएँ", "operationId": "retry_operation_v1_operations__operation_id__retry_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Operation Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रेषक नियमों का अनुप्रयोग पुनः प्रारंभ होता है: kind=sender_rules, status=failed. इस पद्धति का उपयोग करके पत्र भेजना दोहराया नहीं जा सकता। अनुपयुक्त स्थिति के लिए, 409 लौटा दिया जाता है; इस पद्धति के माध्यम से मेलबॉक्स के निर्माण और कॉन्फ़िगरेशन को दोहराना उपलब्ध नहीं है और 403 लौटाता है।" } ``` # PUT /v1/mailboxes/{mailbox_id}/drafts/{draft_id} मसौदा सेव करें draft_id. तक ड्राफ्ट बनाता या अपडेट करता है नए ड्राफ्ट के लिए, UUID जेनरेट करता है; बाद में सहेजने के लिए, उसी पहचानकर्ता का उपयोग करें। आप उसी मेलबॉक्स में लॉग इन करने के बाद किसी अन्य डिवाइस से अपना ड्राफ्ट जारी रख सकते हैं। ```sh curl -X PUT 'https://adapt-mail.com/v1/mailboxes//drafts/' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"to":["team@example.com"],"subject":"Hello","text":"A message from Adapt Mail"}' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "मसौदा सेव करें", "operationId": "save_draft_v1_mailboxes__mailbox_id__drafts__draft_id__put", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Draft Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftInput" } } } }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "draft_id. तक ड्राफ्ट बनाता या अपडेट करता है नए ड्राफ्ट के लिए, UUID जेनरेट करता है; बाद में सहेजने के लिए, उसी पहचानकर्ता का उपयोग करें। आप उसी मेलबॉक्स में लॉग इन करने के बाद किसी अन्य डिवाइस से अपना ड्राफ्ट जारी रख सकते हैं।" } ``` # DELETE /v1/mailboxes/{mailbox_id}/drafts/{draft_id} ड्राफ्ट हटाएं किसी ड्राफ्ट को हटाने से उस ईमेल पर कोई प्रभाव नहीं पड़ता है जो पहले से ही कतारबद्ध है। ```sh curl -X DELETE 'https://adapt-mail.com/v1/mailboxes//drafts/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "ड्राफ्ट हटाएं", "operationId": "delete_draft_v1_mailboxes__mailbox_id__drafts__draft_id__delete", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Draft Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "किसी ड्राफ्ट को हटाने से उस ईमेल पर कोई प्रभाव नहीं पड़ता है जो पहले से ही कतारबद्ध है।" } ``` # GET /v1/mailboxes/{mailbox_id}/drafts ड्राफ्ट की सूची नवीनतम से लेकर सबसे पुराने तक, 100 ड्राफ्ट तक लौटाता है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//drafts' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "ड्राफ्ट की सूची", "operationId": "drafts_v1_mailboxes__mailbox_id__drafts_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "mailbox_id": { "type": "integer" }, "data": { "$ref": "#/components/schemas/DraftInput" }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "नवीनतम से लेकर सबसे पुराने तक, 100 ड्राफ्ट तक लौटाता है।" } ``` # GET /v1/mailboxes/{mailbox_id}/threads संवादों की सूची सबसे हाल ही में अपडेट किए गए संवादों से आरंभ करते हुए, अधिकतम 100 संवाद लौटाता है। फ़ोल्डर Trash और Junk के संदेश सूची में शामिल नहीं हैं। नया पत्र थोड़े विलंब से प्रकट हो सकता है; सूची को अद्यतन करने के लिए अनुरोध पुनः प्रयास करें। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//threads' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "संवादों की सूची", "operationId": "threads_v1_mailboxes__mailbox_id__threads_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "thread_id": { "type": "string" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "messages": { "type": "integer" }, "unread": { "type": "integer" }, "senders": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "sender": { "type": "string" } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "सबसे हाल ही में अपडेट किए गए संवादों से आरंभ करते हुए, अधिकतम 100 संवाद लौटाता है। फ़ोल्डर Trash और Junk के संदेश सूची में शामिल नहीं हैं। नया पत्र थोड़े विलंब से प्रकट हो सकता है; सूची को अद्यतन करने के लिए अनुरोध पुनः प्रयास करें।" } ``` # GET /v1/mailboxes/{mailbox_id}/threads/{thread_id} संवाद के पत्र चयनित वार्तालाप के 100 अक्षरों तक, पुराने से नए तक लौटाता है। संवाद सूची से thread_id पास करें। जो ईमेल पहले ही हटा दिए गए हैं या अब उपलब्ध नहीं हैं, उन्हें प्रतिक्रिया में शामिल नहीं किया गया है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//threads/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "संवाद के पत्र", "operationId": "thread_v1_mailboxes__mailbox_id__threads__thread_id__get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "चयनित वार्तालाप के 100 अक्षरों तक, पुराने से नए तक लौटाता है। संवाद सूची से thread_id पास करें। जो ईमेल पहले ही हटा दिए गए हैं या अब उपलब्ध नहीं हैं, उन्हें प्रतिक्रिया में शामिल नहीं किया गया है।" } ``` # PUT /v1/mailboxes/{mailbox_id}/sender-rules प्रेषक नियम पते के लिए एक नियम बनाता या अपडेट करता है sender. प्रेषक से नए ईमेल को स्पैम में भेजने के लिए action=spam निर्दिष्ट करता है, या उसके ईमेल को अनुमति देने के लिए action=allow निर्दिष्ट करता है। यह नियम भविष्य में आने वाले ईमेल पर लागू होता है। ```sh curl -X PUT 'https://adapt-mail.com/v1/mailboxes//sender-rules' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"sender":"sender@example.com","action":"spam"}' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "प्रेषक नियम", "operationId": "sender_rule_v1_mailboxes__mailbox_id__sender_rules_put", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SenderRule" } } } }, "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "पते के लिए एक नियम बनाता या अपडेट करता है sender. प्रेषक से नए ईमेल को स्पैम में भेजने के लिए action=spam निर्दिष्ट करता है, या उसके ईमेल को अनुमति देने के लिए action=allow निर्दिष्ट करता है। यह नियम भविष्य में आने वाले ईमेल पर लागू होता है।" } ``` # GET /v1/mailboxes/{mailbox_id}/sender-rules प्रेषक नियमों की सूची चयनित मेलबॉक्स के लिए प्रेषक नियम लौटाता है। प्रत्येक नियम में एक पता sender, एक क्रिया action और बाद में हटाने के लिए एक पहचानकर्ता id होता है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//sender-rules' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "प्रेषक नियमों की सूची", "operationId": "rules_v1_mailboxes__mailbox_id__sender_rules_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "mailbox_id": { "type": "integer" }, "sender": { "type": "string" }, "action": { "type": "string", "enum": [ "spam", "allow" ] }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "चयनित मेलबॉक्स के लिए प्रेषक नियम लौटाता है। प्रत्येक नियम में एक पता sender, एक क्रिया action और बाद में हटाने के लिए एक पहचानकर्ता id होता है।" } ``` # DELETE /v1/mailboxes/{mailbox_id}/sender-rules/{rule_id} प्रेषक नियम हटाएँ प्रेषक नियम को rule_id. द्वारा हटा देता है। बाद के संदेशों को सामान्य मेल नियमों द्वारा संसाधित किया जाता है। पहले से प्राप्त संदेश उनके फ़ोल्डरों में रहते हैं। ```sh curl -X DELETE 'https://adapt-mail.com/v1/mailboxes//sender-rules/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "प्रेषक नियम हटाएँ", "operationId": "delete_rule_v1_mailboxes__mailbox_id__sender_rules__rule_id__delete", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Rule Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रेषक नियम को rule_id. द्वारा हटा देता है। बाद के संदेशों को सामान्य मेल नियमों द्वारा संसाधित किया जाता है। पहले से प्राप्त संदेश उनके फ़ोल्डरों में रहते हैं।" } ``` # GET /v1/mailboxes/{mailbox_id}/contacts संपर्क सूची नाम के अनुसार क्रमबद्ध 1000 संपर्क तक लौटाता है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//contacts' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "संपर्क सूची", "operationId": "contacts_v1_mailboxes__mailbox_id__contacts_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponse" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "नाम के अनुसार क्रमबद्ध 1000 संपर्क तक लौटाता है।" } ``` # POST /v1/mailboxes/{mailbox_id}/contacts संपर्क सहेजें चयनित मेलबॉक्स में संपर्क का नाम और पता सहेजता है। यदि समान email वाला कोई संपर्क पहले से मौजूद है, तो डुप्लिकेट बनाए बिना उसका नाम अपडेट करें। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//contacts' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"email":"team@example.com","name":"Support team"}' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "संपर्क सहेजें", "operationId": "add_contact_v1_mailboxes__mailbox_id__contacts_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "चयनित मेलबॉक्स में संपर्क का नाम और पता सहेजता है। यदि समान email वाला कोई संपर्क पहले से मौजूद है, तो डुप्लिकेट बनाए बिना उसका नाम अपडेट करें।" } ``` # DELETE /v1/mailboxes/{mailbox_id}/contacts/{contact_id} संपर्क हटाएँ किसी संपर्क को हटाने से संदेश नहीं हटते. ```sh curl -X DELETE 'https://adapt-mail.com/v1/mailboxes//contacts/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Почтовый ящик" ], "summary": "संपर्क हटाएँ", "operationId": "remove_contact_v1_mailboxes__mailbox_id__contacts__contact_id__delete", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Contact Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "किसी संपर्क को हटाने से संदेश नहीं हटते." } ``` # GET /v1/mailboxes/{mailbox_id}/files फाइलों की सूची चयनित मेलबॉक्स की 1000 तैयार फ़ाइलें लौटाता है। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//files' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Файлы" ], "summary": "फाइलों की सूची", "operationId": "files_v1_mailboxes__mailbox_id__files_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "filename": { "type": "string" }, "content_type": { "type": "string" }, "size_bytes": { "type": "integer" }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "चयनित मेलबॉक्स की 1000 तैयार फ़ाइलें लौटाता है।" } ``` # POST /v1/mailboxes/{mailbox_id}/files फ़ाइल अपलोड करें multipart/form-data, फ़ील्ड file. आकार 1 बाइट से 25 MiB तक। डाउनलोड करने से पहले एंटीवायरस फ़ाइल की जाँच करता है। अपर्याप्त कोटा 409 देता है, बड़ा आकार - 413, पता चला खतरा - 422, अनुपलब्ध चेक - 503। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//files' \ -H 'Authorization: Bearer ' \ -F 'file=@document.pdf' ``` ```json { "tags": [ "Файлы" ], "summary": "फ़ाइल अपलोड करें", "operationId": "upload_v1_mailboxes__mailbox_id__files_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_v1_mailboxes__mailbox_id__files_post" } } } }, "responses": { "201": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "आकार से अधिक हो गया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "multipart/form-data, फ़ील्ड file. आकार 1 बाइट से 25 MiB तक। डाउनलोड करने से पहले एंटीवायरस फ़ाइल की जाँच करता है। अपर्याप्त कोटा 409 देता है, बड़ा आकार - 413, पता चला खतरा - 422, अनुपलब्ध चेक - 503।" } ``` # GET /v1/mailboxes/{mailbox_id}/files/{file_id}/download डाउनलोड फ़ाइल प्रतिक्रिया में Content-Disposition: attachment. के साथ फ़ाइल बाइट्स शामिल हैं लिंक को प्रत्येक अनुरोध पर प्राधिकरण की आवश्यकता होती है; सार्वजनिक URL संग्रहण जारी नहीं किया गया है. ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//files//download' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Файлы" ], "summary": "डाउनलोड फ़ाइल", "operationId": "download_v1_mailboxes__mailbox_id__files__file_id__download_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-File-Scan": { "schema": { "type": "string" } }, "X-File-Scanned-At": { "schema": { "type": "string" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रतिक्रिया में Content-Disposition: attachment. के साथ फ़ाइल बाइट्स शामिल हैं लिंक को प्रत्येक अनुरोध पर प्राधिकरण की आवश्यकता होती है; सार्वजनिक URL संग्रहण जारी नहीं किया गया है." } ``` # GET /v1/mailboxes/{mailbox_id}/files/{file_id}/content फ़ाइल सामग्री DOC, XLS, XLSX, PPT, PPTX और ODT की फ़ाइल या अटैचमेंट सामग्री के अनुरोध में preview=pdf जोड़ें। सीमा: प्रति मेलबॉक्स प्रति मिनट 10 रूपांतरण। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//files//content' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Файлы" ], "summary": "फ़ाइल सामग्री", "operationId": "content_v1_mailboxes__mailbox_id__files__file_id__content_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } }, { "name": "preview", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pdf" ] } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-File-Scan": { "schema": { "type": "string" } }, "X-File-Scanned-At": { "schema": { "type": "string" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DOC, XLS, XLSX, PPT, PPTX और ODT की फ़ाइल या अटैचमेंट सामग्री के अनुरोध में preview=pdf जोड़ें। सीमा: प्रति मेलबॉक्स प्रति मिनट 10 रूपांतरण।" } ``` # DELETE /v1/mailboxes/{mailbox_id}/files/{file_id} फ़ाइल नष्ट करें अपूर्ण सबमिशन फ़ाइल को हटाया नहीं जा सकता: प्रतिक्रिया 409। हटाने के बाद कोटा जारी किया जाता है। ```sh curl -X DELETE 'https://adapt-mail.com/v1/mailboxes//files/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Файлы" ], "summary": "फ़ाइल नष्ट करें", "operationId": "remove_v1_mailboxes__mailbox_id__files__file_id__delete", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "अपूर्ण सबमिशन फ़ाइल को हटाया नहीं जा सकता: प्रतिक्रिया 409। हटाने के बाद कोटा जारी किया जाता है।" } ``` # POST /v1/auth/login-link साइन इन लिंक बनाएँ आपका सर्वर X-API-Key और X-Customer-ID के साथ POST /v1/auth/login-link को कॉल करता है। केवल एक मेलबॉक्स खोलने के लिए mailbox_id दें; पूरा खाता खोलने के लिए इसे छोड़ दें। locale इंटरफ़ेस की भाषा चुनता है। ```sh curl -X POST 'https://adapt-mail.com/v1/auth/login-link' \ -H 'X-API-Key: ' \ -H 'X-Customer-ID: ' \ -H 'Content-Type: application/json' \ --data '{"mailbox_id":1,"locale":"en"}' ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "साइन इन लिंक बनाएँ", "operationId": "login_link_v1_auth_login_link_post", "security": [ { "PartnerKey": [], "Customer": [] } ], "parameters": [ { "name": "X-Customer-ID", "in": "header", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginLinkInput" } } } }, "responses": { "201": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginLinkResult" } } } }, "401": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "आपका सर्वर X-API-Key और X-Customer-ID के साथ POST /v1/auth/login-link को कॉल करता है। केवल एक मेलबॉक्स खोलने के लिए mailbox_id दें; पूरा खाता खोलने के लिए इसे छोड़ दें। locale इंटरफ़ेस की भाषा चुनता है।" } ``` # POST /v1/auth/login-link/consume लिंक के बदले सत्र प्राप्त करें केवल adapt-mail.com साइन इन पृष्ठ के लिए: Origin: https://adapt-mail.com के साथ POST करें। session_id और HttpOnly कुकीज़ मिलती हैं। इस्तेमाल किए गए या समय सीमा समाप्त लिंक के लिए HTTP 410 मिलता है। ```sh curl -X POST 'https://adapt-mail.com/v1/auth/login-link/consume' \ -H 'Origin: https://adapt-mail.com' \ -c cookies.txt \ -H 'Content-Type: application/json' \ --data '{"token":""}' ``` ```json { "tags": [ "Авторизация и аккаунт" ], "summary": "लिंक के बदले सत्र प्राप्त करें", "operationId": "consume_login_link_v1_auth_login_link_consume_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginLinkConsume" } } }, "required": true }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserSessionResult" } } } }, "403": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "अनुरोध में त्रुटि", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "केवल adapt-mail.com साइन इन पृष्ठ के लिए: Origin: https://adapt-mail.com के साथ POST करें। session_id और HttpOnly कुकीज़ मिलती हैं। इस्तेमाल किए गए या समय सीमा समाप्त लिंक के लिए HTTP 410 मिलता है।", "security": [] } ``` # GET /v1/mailboxes/{mailbox_id}/templates ईमेल टेम्पलेट प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//templates' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "ईमेल टेम्पलेट", "operationId": "templates_v1_mailboxes__mailbox_id__templates_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateRecord" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता।" } ``` # POST /v1/mailboxes/{mailbox_id}/templates ईमेल टेम्पलेट प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//templates' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"name":""}' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "ईमेल टेम्पलेट", "operationId": "create_template_v1_mailboxes__mailbox_id__templates_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "201": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateRecord" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता।" } ``` # PUT /v1/mailboxes/{mailbox_id}/templates/{template_id} ईमेल टेम्पलेट प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता। ```sh curl -X PUT 'https://adapt-mail.com/v1/mailboxes//templates/' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"name":""}' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "ईमेल टेम्पलेट", "operationId": "update_template_v1_mailboxes__mailbox_id__templates__template_id__put", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateRecord" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता।" } ``` # DELETE /v1/mailboxes/{mailbox_id}/templates/{template_id} ईमेल टेम्पलेट प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता। ```sh curl -X DELETE 'https://adapt-mail.com/v1/mailboxes//templates/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "ईमेल टेम्पलेट", "operationId": "delete_template_v1_mailboxes__mailbox_id__templates__template_id__delete", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "const": true } } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "प्रति मेलबॉक्स अधिकतम 100 टेम्पलेट। फ़ील्ड: name, subject, text और html; HTML साफ़ किया जाता है। टेम्पलेट अपने आप ईमेल नहीं भेजता।" } ``` # GET /v1/mailboxes/{mailbox_id}/autoresponder स्वचालित उत्तर स्वचालित उत्तर की तारीखों में समय क्षेत्र दें; repeat_days 1 से 30 तक है। केवल नए व्यक्तिगत संदेशों का उत्तर दिया जाता है: From और Return-Path का मेल होना चाहिए। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//autoresponder' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "स्वचालित उत्तर", "operationId": "autoresponder_v1_mailboxes__mailbox_id__autoresponder_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Autoresponder" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "स्वचालित उत्तर की तारीखों में समय क्षेत्र दें; repeat_days 1 से 30 तक है। केवल नए व्यक्तिगत संदेशों का उत्तर दिया जाता है: From और Return-Path का मेल होना चाहिए।" } ``` # PUT /v1/mailboxes/{mailbox_id}/autoresponder स्वचालित उत्तर स्वचालित उत्तर की तारीखों में समय क्षेत्र दें; repeat_days 1 से 30 तक है। केवल नए व्यक्तिगत संदेशों का उत्तर दिया जाता है: From और Return-Path का मेल होना चाहिए। ```sh curl -X PUT 'https://adapt-mail.com/v1/mailboxes//autoresponder' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"enabled":false,"subject":"","text":"","starts_at":"2026-11-01T12:00:00Z","ends_at":"2026-11-01T12:00:00Z","repeat_days":7}' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "स्वचालित उत्तर", "operationId": "set_autoresponder_v1_mailboxes__mailbox_id__autoresponder_put", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Autoresponder" } } } }, "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Autoresponder" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "स्वचालित उत्तर की तारीखों में समय क्षेत्र दें; repeat_days 1 से 30 तक है। केवल नए व्यक्तिगत संदेशों का उत्तर दिया जाता है: From और Return-Path का मेल होना चाहिए।" } ``` # GET /v1/mailboxes/{mailbox_id}/filters फ़िल्टर फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें। ```sh curl -X GET 'https://adapt-mail.com/v1/mailboxes//filters' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "फ़िल्टर", "operationId": "filters_v1_mailboxes__mailbox_id__filters_get", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "200": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FilterRecord" } } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें।" } ``` # POST /v1/mailboxes/{mailbox_id}/filters फ़िल्टर फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//filters' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"name":"","conditions":[{"field":"from","operator":"contains","value":""}]}' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "फ़िल्टर", "operationId": "create_filter_v1_mailboxes__mailbox_id__filters_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailFilter" } } } }, "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterChange" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें।" } ``` # PUT /v1/mailboxes/{mailbox_id}/filters/{filter_id} फ़िल्टर फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें। ```sh curl -X PUT 'https://adapt-mail.com/v1/mailboxes//filters/' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data '{"name":"","conditions":[{"field":"from","operator":"contains","value":""}]}' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "फ़िल्टर", "operationId": "update_filter_v1_mailboxes__mailbox_id__filters__filter_id__put", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "filter_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Filter Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailFilter" } } } }, "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterChange" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें।" } ``` # DELETE /v1/mailboxes/{mailbox_id}/filters/{filter_id} फ़िल्टर फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें। ```sh curl -X DELETE 'https://adapt-mail.com/v1/mailboxes//filters/' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "फ़िल्टर", "operationId": "delete_filter_v1_mailboxes__mailbox_id__filters__filter_id__delete", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "filter_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Filter Id" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें।" } ``` # POST /v1/mailboxes/{mailbox_id}/filters/{filter_id}/apply मौजूदा संदेशों पर लागू करें फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें। ```sh curl -X POST 'https://adapt-mail.com/v1/mailboxes//filters//apply' \ -H 'Authorization: Bearer ' ``` ```json { "tags": [ "Настройки ящика" ], "summary": "मौजूदा संदेशों पर लागू करें", "operationId": "apply_filter_v1_mailboxes__mailbox_id__filters__filter_id__apply_post", "security": [ { "PartnerKey": [], "Customer": [] }, { "Session": [] }, { "Browser": [] } ], "parameters": [ { "name": "mailbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Mailbox Id" } }, { "name": "filter_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Filter Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 120, "title": "Idempotency-Key" } }, { "name": "X-Customer-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Customer-Id" } } ], "responses": { "202": { "description": "सफल प्रतिक्रिया", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "401": { "description": "लॉगिन आवश्यक है", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "तक पहुँच नहीं", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "संसाधन नहीं मिला", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "राज्य संघर्ष", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "503": { "description": "अस्थायी अनुपलब्धता", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "फ़िल्टर बदलने पर operation मिलता है। पुराने संदेशों पर लागू करने के लिए 8–120 वर्णों का Idempotency-Key चाहिए। दोबारा प्रयास में वही कुंजी दें; स्थिति GET /v1/operations/{operation_id} से देखें।" } ``` # Schemas ```json { "Body_upload_v1_mailboxes__mailbox_id__files_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_v1_mailboxes__mailbox_id__files_post" }, "Contact": { "properties": { "email": { "type": "string", "title": "Email" }, "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "email", "name" ], "title": "Contact", "example": { "email": "team@example.com", "name": "Support team" } }, "DraftInput": { "properties": { "to": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "To", "description": "मुख्य प्राप्तकर्ताओं के पते." }, "cc": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Cc", "description": "अन्य प्रतिभागियों को दिखाई देने वाले प्राप्तकर्ता पते की प्रतिलिपि बनाएँ।" }, "bcc": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Bcc", "description": "प्राप्तकर्ता पते की गुप्त प्रतिलिपि." }, "subject": { "type": "string", "maxLength": 998, "title": "Subject", "default": "", "description": "पत्र का विषय." }, "text": { "type": "string", "maxLength": 200000, "title": "Text", "default": "", "description": "बिना फ़ॉर्मेट किए पत्र का पाठ." }, "html": { "anyOf": [ { "type": "string", "maxLength": 300000 }, { "type": "null" } ], "title": "Html", "description": "पत्र का HTML-स्वरूपित संस्करण।" }, "file_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 20, "title": "File Ids", "description": "इस मेलबॉक्स में ID पहले डाउनलोड की गई फ़ाइलें। डाउनलोड करते समय या फ़ाइलों की सूची से उन्हें प्राप्त करें।" }, "forward_message": { "anyOf": [ { "$ref": "#/components/schemas/MessageReference" }, { "type": "null" } ], "description": "मूल ईमेल जिसके अनुलग्नकों को अग्रेषित करने की आवश्यकता है।" }, "reply_to_message_id": { "anyOf": [ { "type": "string", "maxLength": 998 }, { "type": "null" } ], "title": "Reply To Message Id", "description": "आप जिस ईमेल का उत्तर दे रहे हैं उसका message_id मान।" }, "references": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "References", "description": "उत्तर श्रृंखला को सहेजने के लिए मूल संदेश का मान references है।" }, "send_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Send At", "description": "समय क्षेत्र के साथ विलंबित प्रेषण समय, उदाहरण के लिए 2026-11-01T12:00:00Z. मूल्य के बिना, कतार संसाधित होते ही प्रेषण शुरू हो जाता है।" } }, "additionalProperties": false, "type": "object", "title": "DraftInput", "example": { "to": [ "team@example.com" ], "subject": "Hello", "text": "A message from Adapt Mail" } }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Login": { "properties": { "login": { "type": "string", "title": "Login" }, "password": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Password" }, "mode": { "type": "string", "enum": [ "account", "mailbox" ], "title": "Mode", "default": "account" } }, "additionalProperties": false, "type": "object", "required": [ "login", "password" ], "title": "Login" }, "MailboxUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "quota_mb": { "anyOf": [ { "type": "integer", "minimum": 10240 }, { "type": "null" } ], "title": "Quota Mb" }, "file_quota_mb": { "anyOf": [ { "type": "integer", "maximum": 512000, "minimum": 256 }, { "type": "null" } ], "title": "File Quota Mb" }, "password": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 12 }, { "type": "null" } ], "title": "Password" }, "signature": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ], "title": "Signature" } }, "additionalProperties": false, "type": "object", "title": "MailboxUpdate", "example": { "name": "Support", "signature": "Support team" } }, "MessageAction": { "properties": { "folder": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Folder", "description": "फ़ोल्डर सूची से फ़ोल्डर का नाम, उदाहरण के लिए INBOX." }, "uidvalidity": { "type": "integer", "exclusiveMinimum": 0, "title": "Uidvalidity", "description": "इस फ़ोल्डर के लिए प्रतिक्रिया API से मान uidvalidity है।" }, "uids": { "items": { "type": "integer" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Uids", "description": "एक फ़ोल्डर से चयनित अक्षरों के पहचानकर्ता." }, "action": { "type": "string", "enum": [ "read", "unread", "star", "unstar", "move", "delete" ], "title": "Action" }, "destination": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Destination", "description": "लक्ष्य फ़ोल्डर का नाम. action=move. के लिए आवश्यक" } }, "additionalProperties": false, "type": "object", "required": [ "folder", "uidvalidity", "uids", "action" ], "title": "MessageAction" }, "MessageReference": { "properties": { "folder": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Folder", "description": "फ़ोल्डर सूची से फ़ोल्डर का नाम, उदाहरण के लिए INBOX." }, "uidvalidity": { "type": "integer", "exclusiveMinimum": 0, "title": "Uidvalidity", "description": "इस फ़ोल्डर के लिए प्रतिक्रिया API से मान uidvalidity है।" }, "uid": { "type": "integer", "exclusiveMinimum": 0, "title": "Uid" } }, "additionalProperties": false, "type": "object", "required": [ "folder", "uidvalidity", "uid" ], "title": "MessageReference" }, "NameInput": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "NameInput" }, "SendInput": { "properties": { "to": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "To", "description": "मुख्य प्राप्तकर्ताओं के पते." }, "cc": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Cc", "description": "अन्य प्रतिभागियों को दिखाई देने वाले प्राप्तकर्ता पते की प्रतिलिपि बनाएँ।" }, "bcc": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Bcc", "description": "प्राप्तकर्ता पते की गुप्त प्रतिलिपि." }, "subject": { "type": "string", "maxLength": 998, "title": "Subject", "default": "", "description": "पत्र का विषय." }, "text": { "type": "string", "maxLength": 200000, "title": "Text", "default": "", "description": "बिना फ़ॉर्मेट किए पत्र का पाठ." }, "html": { "anyOf": [ { "type": "string", "maxLength": 300000 }, { "type": "null" } ], "title": "Html", "description": "पत्र का HTML-स्वरूपित संस्करण।" }, "file_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 20, "title": "File Ids", "description": "इस मेलबॉक्स में ID पहले डाउनलोड की गई फ़ाइलें। डाउनलोड करते समय या फ़ाइलों की सूची से उन्हें प्राप्त करें।" }, "forward_message": { "anyOf": [ { "$ref": "#/components/schemas/MessageReference" }, { "type": "null" } ], "description": "मूल ईमेल जिसके अनुलग्नकों को अग्रेषित करने की आवश्यकता है।" }, "reply_to_message_id": { "anyOf": [ { "type": "string", "maxLength": 998 }, { "type": "null" } ], "title": "Reply To Message Id", "description": "आप जिस ईमेल का उत्तर दे रहे हैं उसका message_id मान।" }, "references": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "References", "description": "उत्तर श्रृंखला को सहेजने के लिए मूल संदेश का मान references है।" }, "send_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Send At", "description": "समय क्षेत्र के साथ विलंबित प्रेषण समय, उदाहरण के लिए 2026-11-01T12:00:00Z. मूल्य के बिना, कतार संसाधित होते ही प्रेषण शुरू हो जाता है।" } }, "additionalProperties": false, "type": "object", "required": [ "to" ], "title": "SendInput", "example": { "to": [ "team@example.com" ], "subject": "Hello", "text": "A message from Adapt Mail" } }, "SenderRule": { "properties": { "sender": { "type": "string", "title": "Sender" }, "action": { "type": "string", "enum": [ "spam", "allow" ], "title": "Action", "default": "spam" } }, "additionalProperties": false, "type": "object", "required": [ "sender" ], "title": "SenderRule", "example": { "sender": "sender@example.com", "action": "spam" } }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "Address": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } }, "MessageSummary": { "type": "object", "properties": { "uid": { "type": "integer" }, "uidvalidity": { "type": "integer" }, "folder": { "type": "string" }, "message_id": { "type": "string" }, "thread_id": { "type": "string" }, "sender": { "type": "string" }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "subject": { "type": "string" }, "preview": { "type": "string" }, "flags": { "type": "array", "items": { "type": "string" } }, "size_bytes": { "type": "integer" }, "received_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } }, "Attachment": { "type": "object", "properties": { "index": { "type": "integer" }, "filename": { "type": "string" }, "content_type": { "type": "string" }, "size_bytes": { "type": "integer" } } }, "Message": { "type": "object", "properties": { "uid": { "type": "integer" }, "uidvalidity": { "type": "integer" }, "folder": { "type": "string" }, "message_id": { "type": "string" }, "thread_id": { "type": "string" }, "sender": { "type": "string" }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "subject": { "type": "string" }, "preview": { "type": "string" }, "flags": { "type": "array", "items": { "type": "string" } }, "size_bytes": { "type": "integer" }, "received_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "text": { "type": "string" }, "html": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "cc": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "references": { "type": "string" }, "reply_to": { "type": "string" } } }, "Operation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "स्थिति की जांच करने और लंबित सबमिशन को रद्द करने के लिए ऑपरेशन आईडी।" }, "kind": { "type": "string" }, "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "uncertain", "cancelled" ] }, "run_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "completed_at": { "anyOf": [ { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "यदि ऑपरेशन सफलतापूर्वक पूरा नहीं हुआ तो त्रुटि का कारण।" }, "result": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "ऑपरेशन का नतीजा. भेजने के लिए, स्वीकृत और अस्वीकृत प्राप्तकर्ताओं के बारे में जानकारी शामिल है।" } } }, "SendResult": { "type": "object", "properties": { "message_id": { "type": "string" }, "smtp_accepted": { "type": "boolean" }, "sent_saved": { "type": "boolean" }, "accepted_recipients": { "type": "array", "items": { "type": "string" } }, "rejected_recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "integer" } } } } } }, "Mailbox": { "type": "object", "properties": { "id": { "type": "integer" }, "account_id": { "type": "integer" }, "domain_id": { "type": "integer" }, "email": { "type": "string" }, "name": { "type": "string" }, "quota_mb": { "type": "integer" }, "used_bytes": { "type": "integer" }, "file_quota_bytes": { "type": "integer" }, "file_used_bytes": { "type": "integer" }, "status": { "type": "string" }, "signature": { "type": "string" }, "enabled": { "type": "boolean" }, "access_allowed": { "type": "boolean" }, "paid_until": { "anyOf": [ { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, { "type": "null" } ] }, "ready_at": { "anyOf": [ { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, { "type": "null" } ] }, "delete_after": { "anyOf": [ { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, { "type": "null" } ] }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "reserved_quota_mb": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "outbound_high_limit": { "type": "boolean" }, "outbound_daily_recipient_limit": { "type": "integer" }, "outbound_daily_recipients_used": { "type": "integer" }, "outbound_daily_recipients_remaining": { "type": "integer" }, "outbound_messages_per_minute": { "type": "integer" }, "outbound_minute_messages_used": { "type": "integer" }, "outbound_minute_messages_remaining": { "type": "integer" }, "outbound_recipients_per_message": { "type": "integer" }, "storage_shared": { "type": "boolean", "const": true } } }, "Domain": { "type": "object", "properties": { "id": { "type": "integer" }, "account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "name": { "type": "string" }, "status": { "type": "string" }, "is_shared": { "type": "boolean" }, "verification_token": { "type": "string" }, "dns_status": { "type": "object" }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } }, "File": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "filename": { "type": "string" }, "content_type": { "type": "string" }, "size_bytes": { "type": "integer" }, "scanned_at": { "anyOf": [ { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, { "type": "null" } ] } } }, "ContactResponse": { "type": "object", "properties": { "id": { "type": "integer" }, "mailbox_id": { "type": "integer" }, "email": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } }, "Error": { "type": "object", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, { "type": "array", "items": { "type": "object" } } ] } } }, "LoginLinkInput": { "properties": { "mailbox_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Mailbox Id" }, "locale": { "type": "string", "enum": [ "en", "ru", "fr", "es", "de", "zh-cn", "ko", "tr", "hi", "pt-br" ], "title": "Locale", "default": "en" } }, "additionalProperties": false, "type": "object", "title": "LoginLinkInput" }, "LoginLinkConsume": { "properties": { "token": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$", "title": "Token" } }, "additionalProperties": false, "type": "object", "required": [ "token" ], "title": "LoginLinkConsume" }, "LoginLinkResult": { "properties": { "login_url": { "type": "string", "title": "Login Url" }, "expires_in": { "type": "integer", "const": 300, "title": "Expires In" }, "expires_at": { "type": "string", "title": "Expires At" }, "account_id": { "type": "integer", "title": "Account Id" }, "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mailbox Id" } }, "additionalProperties": false, "type": "object", "required": [ "login_url", "expires_in", "expires_at", "account_id", "mailbox_id" ], "title": "LoginLinkResult" }, "BrowserSessionResult": { "properties": { "mailbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mailbox Id" }, "session_id": { "type": "string", "title": "Session Id" } }, "additionalProperties": false, "type": "object", "required": [ "mailbox_id", "session_id" ], "title": "BrowserSessionResult" }, "MailTemplate": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "subject": { "type": "string", "maxLength": 998, "title": "Subject", "default": "" }, "text": { "type": "string", "maxLength": 20000, "title": "Text", "default": "" }, "html": { "type": "string", "maxLength": 30000, "title": "Html", "default": "" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "MailTemplate" }, "MailFilter": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "match": { "type": "string", "enum": [ "all", "any" ], "title": "Match", "default": "all" }, "conditions": { "items": { "$ref": "#/components/schemas/FilterCondition" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Conditions" }, "mark_read": { "type": "boolean", "title": "Mark Read", "default": false }, "important": { "type": "boolean", "title": "Important", "default": false }, "trash": { "type": "boolean", "title": "Trash", "default": false }, "move_to": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Move To" } }, "additionalProperties": false, "type": "object", "required": [ "name", "conditions" ], "title": "MailFilter" }, "FilterCondition": { "properties": { "field": { "type": "string", "enum": [ "from", "to", "cc", "subject" ], "title": "Field" }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "not_equals" ], "title": "Operator" }, "value": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "FilterCondition" }, "Autoresponder": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "subject": { "type": "string", "maxLength": 200, "title": "Subject", "default": "" }, "text": { "type": "string", "maxLength": 10000, "title": "Text", "default": "" }, "starts_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Starts At" }, "ends_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ends At" }, "repeat_days": { "type": "integer", "maximum": 30, "minimum": 1, "title": "Repeat Days", "default": 7 } }, "additionalProperties": false, "type": "object", "title": "Autoresponder" }, "TemplateRecord": { "type": "object", "required": [ "id", "data", "updated_at" ], "properties": { "id": { "type": "integer" }, "data": { "$ref": "#/components/schemas/MailTemplate" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } }, "FilterRecord": { "type": "object", "required": [ "id", "data", "updated_at" ], "properties": { "id": { "type": "integer" }, "data": { "$ref": "#/components/schemas/MailFilter" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" } } }, "FilterChange": { "type": "object", "required": [ "id", "data", "updated_at", "operation" ], "properties": { "id": { "type": "integer" }, "data": { "$ref": "#/components/schemas/MailFilter" }, "updated_at": { "type": "string", "description": "UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है" }, "operation": { "$ref": "#/components/schemas/Operation" } } } } ```