REST API दस्तावेज़ीकरण

GET/api/email/{domain}/{user}/

उपयोगकर्ता के ईमेल की पृष्ठांकित सूची प्राप्त करें। सूची प्रतिक्रियाओं में केवल मेटाडेटा शामिल है (नहीं body / html_body).

पैरामीटर	जगह	विवरण
domain	पथ	ईमेल डोमेन, उदा. example.com
user	पथ	उपयोगकर्ता नाम, उदा. testuser
page	क्वेरी, वैकल्पिक	पृष्ठ क्रमांक (डिफ़ॉल्ट 1)
limit	क्वेरी, वैकल्पिक	प्रति पृष्ठ आइटम (डिफ़ॉल्ट 20, अधिकतम 100)

curl -X GET "https://BASE_URL/api/email/example.com/testuser/?page=1&limit=20"

{
  "emails": [
    {
      "id": 123,
      "subject": "Welcome",
      "sender": "[email protected]",
      "date": "2026-09-30T10:30:00.000Z",
      "has_attachments": false,
      "size": 1234
    }
  ],
  "total": 5,
  "page": 1,
  "limit": 20,
  "has_more": false
}

GET/api/email/{domain}/{user}/{email_id}

ईमेल का पूरा विवरण प्राप्त करें.

curl -X GET "https://BASE_URL/api/email/example.com/testuser/123"

DELETE/api/email/{domain}/{user}/{email_id}

एक विशिष्ट ईमेल हटाएँ.

curl -X DELETE "https://BASE_URL/api/email/example.com/testuser/123"

{ "status": "deleted" }

POST/api/add-domain/{domain}

एक नया डोमेन जोड़ें या मौजूदा डोमेन की ऑनलाइन स्थिति अपडेट करें। डोमेन में एक एमएक्स रिकॉर्ड होना चाहिए जो स्वीकार किए जाने वाले सिस्टम के होस्टनाम की ओर इंगित करता हो (स्थिति)। added, is_online: true).

curl -X POST "https://BASE_URL/api/add-domain/newdomain.com"

// सफलतापूर्वक जोड़ा गया
{ "status": "added", "domain": "newdomain.com", "is_online": true }

// मौजूदा डोमेन: इसकी स्थिति अपडेट करें
{ "status": "updated", "domain": "newdomain.com", "is_online": false }

GET/api/all-domains/ & /api/random-domains/

सभी ऑनलाइन डोमेन (निजी, टोकन आवश्यक):

curl -X GET "https://BASE_URL/api/all-domains/" \
  -H "X-Domain-Token: YOUR_TOKEN"

यादृच्छिक ऑनलाइन डोमेन (सार्वजनिक):

curl -X GET "https://BASE_URL/api/random-domains/?limit=10"

{ "domains": ["domain1.com", "domain2.com"], "total": 2 }

GET/api/check-mx/{domain}

जांचें कि क्या डोमेन के पास सिस्टम की ओर इशारा करने वाला वैध एमएक्स रिकॉर्ड है।

curl -X GET "https://BASE_URL/api/check-mx/example.com"

{ "result": "online" }   // या "offline"

त्रुटि प्रबंधन

कोड	अर्थ
200	सफलता
400	अमान्य अनुरोध (उदा. विकृत डोमेन/ईमेल)
401	निजी समापन बिंदु के लिए गुम या अमान्य टोकन
404	ईमेल नहीं मिला
429	दर सीमा पार हो गई

{ "detail": "Domain not found" }

महत्वपूर्ण नोट्स

• ईमेल पते को प्रारूप का उपयोग करना चाहिए [email protected]
• केवल वैध एमएक्स रिकॉर्ड वाले डोमेन को "ऑनलाइन" स्थिति प्राप्त है
• इसके बाद ईमेल और निष्क्रिय डोमेन स्वचालित रूप से हटा दिए जाते हैं 3 दिन
• केवल सेवा प्राप्त करता है ईमेल - भेजना और एसएमटीपी रिले समर्थित नहीं हैं
• एपीआई प्रति-आईपी दर सीमा लागू करता है
• 3 दिन की अवधारण अवधि लाइव सेवा पर लागू होती है; बैकअप प्रतियों को अधिक समय तक बनाए रख सकता है। उस समय सभी प्रतियों से स्थायी विलोपन की गारंटी नहीं है।
• कस्टम-डोमेन इनबॉक्स सार्वजनिक रहते हैं और तृतीय-पक्ष सेवाओं द्वारा अवरुद्ध किए जा सकते हैं। स्वीकृति और वितरण की गारंटी नहीं है.