Mailtrap

आधिकारिक

Mailtrap ईमेल API के साथ एकीकृत होता है।

GitHub
65
इस MCP को आज़माएँप्रायोजित

Mailtrap MCP के साथ आप क्या कर सकते हैं?

  • ट्रांज़ैक्शनल ईमेल भेजें — अपने असिस्टेंट से इनलाइन सामग्री या टेम्पलेट के साथ ट्रांज़ैक्शनल ईमेल भेजने के लिए कहें, send-email का उपयोग करके।
  • सैंडबॉक्स में ईमेल का परीक्षण करें — सैंडबॉक्स इनबॉक्स में परीक्षण ईमेल भेजें और सामग्री, स्पैम स्कोर, और HTML विश्लेषण की जाँच करें।
  • डिलीवरी लॉग की निगरानी करें — ईमेल लॉग खोजें और डिलीवरी समस्याओं को डीबग करने के लिए इवेंट इतिहास का निरीक्षण करें, list-email-logs के साथ।
  • ईमेल टेम्पलेट प्रबंधित करें — प्राकृतिक भाषा कमांड का उपयोग करके टेम्पलेट बनाएं, सूचीबद्ध करें, अपडेट करें, या हटाएं।
  • सेंडिंग आँकड़ों का विश्लेषण करें — किसी भी तारीख सीमा के लिए डिलीवरी, बाउंस, ओपन, और क्लिक दरें प्राप्त करें, get-sending-stats के साथ।
  • सेंडिंग डोमेन प्रबंधित करें — DNS सत्यापन और क्लिक ट्रैकिंग के साथ सेंडिंग डोमेन सूचीबद्ध करें, बनाएं, और कॉन्फ़िगर करें।

दस्तावेज़

TypeScript test NPM

आधिकारिक Mailtrap MCP सर्वर

Mailtrap के लिए आधिकारिक MCP सर्वर — ईमेल डिलीवरी प्लेटफ़ॉर्म। यह आपके Mailtrap खाते को Claude, Cursor, VS Code और अन्य MCP-संगत AI सहायकों से जोड़ता है।

ट्रांज़ैक्शनल और बल्क ईमेल भेजें, Email Sandbox में सुरक्षित रूप से संदेशों का परीक्षण करें, टेम्पलेट, संपर्क, भेजने वाले डोमेन और वेबहुक प्रबंधित करें, ईमेल लॉग और डिलीवरी आँकड़े देखें, डिलीवरेबिलिटी समस्याओं का निवारण करें, और खाता संसाधनों का प्रबंधन करें — यह सब प्राकृतिक भाषा के प्रॉम्प्ट का उपयोग करके।

क्षमताएँ

  • Email API और SMTP — ट्रांज़ैक्शनल और बल्क ईमेल भेजें, जिसमें बैच और टेम्पलेट-आधारित संदेश शामिल हैं।
  • ईमेल परीक्षण — Email Sandbox में संदेशों का परीक्षण करें और सामग्री, हेडर, अटैचमेंट, स्पैम स्कोर और HTML क्लाइंट संगतता की जाँच करें।
  • डिलीवरी निगरानी — ईमेल लॉग खोजें, इवेंट इतिहास देखें, और डिलीवरी, बाउंस, ओपन, क्लिक और स्पैम दरों का विश्लेषण करें।
  • ईमेल इंफ्रास्ट्रक्चर — भेजने वाले डोमेन, DNS सत्यापन, वेबहुक और सप्रेशन प्रबंधित करें।
  • संपर्क — संपर्क, सूचियाँ, कस्टम फ़ील्ड और इवेंट प्रबंधित करें, आयात और निर्यात के साथ।
  • खाता प्रबंधन — बिलिंग उपयोग की समीक्षा करें और एक्सेस, अनुमतियाँ, API टोकन और उप-खाते प्रबंधित करें।

समर्थित MCP क्लाइंट

Claude Desktop, Claude Code, Cursor, VS Code और किसी भी अन्य MCP-संगत क्लाइंट के साथ काम करता है। प्रत्येक के लिए सेटअप निर्देश नीचे दिए गए हैं।

पूर्वापेक्षाएँ

इस MCP सर्वर का उपयोग करने से पहले, आपको यह करना होगा:

  1. Mailtrap खाता बनाएँ
  2. अपना डोमेन सत्यापित करें
  3. Mailtrap API सेटिंग्स से अपना API टोकन प्राप्त करें
  4. Mailtrap खाता प्रबंधन से अपना खाता ID प्राप्त करें

आवश्यक पर्यावरण चर:

  • MAILTRAP_API_TOKEN - सभी कार्यक्षमता के लिए आवश्यक
  • MAILTRAP_ACCOUNT_ID - टेम्पलेट, आँकड़े, ईमेल लॉग, सैंडबॉक्स सूची/दिखाएँ, भेजने वाले डोमेन और सप्रेशन के लिए आवश्यक। केवल भेजने वाले टूल (send-email, send-sandbox-email, और batch-send-* टूल), ईमेल कैंपेन टूल, कंपनी जानकारी टूल और ट्रैकिंग ऑप्ट-आउट टूल के लिए वैकल्पिक।

वैकल्पिक (टूल पैरामीटर के रूप में भी पास किए जा सकते हैं):

  • DEFAULT_FROM_EMAIL - डिफ़ॉल्ट प्रेषक ईमेल जब from send-email, send-sandbox-email, या batch-send-* टूल को प्रदान नहीं किया जाता है (जहाँ यह base.from भरता है)। from पैरामीटर के माध्यम से प्रति कॉल प्रेषक बदलने में सक्षम बनाता है।
  • MAILTRAP_SANDBOX_ID - सैंडबॉक्स टूल के लिए डिफ़ॉल्ट सैंडबॉक्स ID जब sandbox_id प्रदान नहीं किया जाता है। sandbox_id पैरामीटर के माध्यम से प्रति कॉल सैंडबॉक्स के बीच स्विच करने में सक्षम बनाता है।
  • MAILTRAP_TEST_INBOX_ID - सैंडबॉक्स टूल के लिए डिफ़ॉल्ट परीक्षण इनबॉक्स ID जब test_inbox_id प्रदान नहीं किया जाता है। test_inbox_id पैरामीटर के माध्यम से प्रति कॉल इनबॉक्स के बीच स्विच करने में सक्षम बनाता है। MAILTRAP_SANDBOX_ID के लिए लीगेसी उपनाम, फिर भी फ़ॉलबैक के रूप में मान्य।
  • MAILTRAP_ORGANIZATION_ID - संगठन टूल के लिए आवश्यक (list-sub-accounts, create-sub-account)।
  • MAILTRAP_ORGANIZATION_API_TOKEN - संगठन-स्कोप्ड API टोकन। संगठन टूल के लिए आवश्यक (MAILTRAP_API_TOKEN से अलग)।

त्वरित इंस्टॉल

Install in Cursor

Install with Node in VS Code

Smithery CLI

Smithery एक रजिस्ट्री इंस्टॉलर और MCP सर्वर का प्रबंधक है जो सभी AI क्लाइंट के साथ काम करता है।

npx @smithery/cli install mailtrap

Smithery स्वचालित रूप से क्लाइंट कॉन्फ़िगरेशन संभालता है और एक इंटरैक्टिव सेटअप प्रक्रिया प्रदान करता है। स्थानीय रूप से MCP सर्वर के साथ शुरू करने का यह सबसे आसान तरीका है।

सेटअप

Claude Desktop

Mailtrap सर्वर इंस्टॉल करने के लिए MCPB का उपयोग करें। आप उन फ़ाइलों को Releases में पा सकते हैं।
.MCPB फ़ाइल डाउनलोड करें और इसे खोलें। यदि आपके पास Claude Desktop है - यह इसे खोलेगा और कॉन्फ़िगर करने का सुझाव देगा।

Claude Desktop या Cursor

निम्नलिखित कॉन्फ़िगरेशन जोड़ें:

{
  "mcpServers": {
    "mailtrap": {
      "command": "npx",
      "args": ["-y", "mcp-mailtrap"],
      "env": {
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
      }
    }
  }
}

यदि आप Node.js प्रबंधित करने के लिए asdf का उपयोग कर रहे हैं तो आपको निष्पादन योग्य का पूर्ण पथ उपयोग करना होगा (Mac के लिए उदाहरण)

{
  "mcpServers": {
    "mailtrap": {
      "command": "/Users/<username>/.asdf/shims/npx",
      "args": ["-y", "mcp-mailtrap"],
      "env": {
        "PATH": "/Users/<username>/.asdf/shims:/usr/bin:/bin",
        "ASDF_DIR": "/opt/homebrew/opt/asdf/libexec",
        "ASDF_DATA_DIR": "/Users/<username>/.asdf",
        "ASDF_NODEJS_VERSION": "20.6.1",
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
      }
    }
  }
}

Claude Desktop कॉन्फ़िग फ़ाइल स्थान

Mac: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

Cursor कॉन्फ़िग फ़ाइल स्थान

Mac: ~/.cursor/mcp.json

Windows: %USERPROFILE%\.cursor\mcp.json

VS Code

मैन्युअल रूप से कॉन्फ़िग बदलना

कमांड पैलेट में चलाएँ: Preferences: Open User Settings (JSON)

फिर, सेटिंग्स फ़ाइल में, निम्नलिखित कॉन्फ़िगरेशन जोड़ें:

{
  "mcp": {
    "servers": {
      "mailtrap": {
        "command": "npx",
        "args": ["-y", "mcp-mailtrap"],
        "env": {
          "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
          "DEFAULT_FROM_EMAIL": "your_sender@example.com",
          "MAILTRAP_ACCOUNT_ID": "your_account_id",
          "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
        }
      }
    }
  }
}

[!TIP] "env" अनुभाग बदलने के बाद अपने MCP सर्वर को पुनः आरंभ करना न भूलें।

MCP बंडल (MCPB)

MCP बंडल का समर्थन करने वाले होस्ट में आसान इंस्टॉलेशन के लिए, आप एक .mcpb बंडल फ़ाइल वितरित कर सकते हैं।

# Build TypeScript and pack the MCPB bundle
npm run mcpb:pack

# Inspect bundle metadata
npm run mcpb:info

# Sign the bundle for distribution (optional)
npm run mcpb:sign

यह रिपॉजिटरी manifest.json और dist/ में निर्मित आर्टिफैक्ट का उपयोग करके mailtrap-mcp.mcpb बनाता है।

उपयोग

कॉन्फ़िगर होने के बाद, आप एजेंट से ईमेल भेजने और टेम्पलेट प्रबंधित करने के लिए कह सकते हैं, उदाहरण के लिए:

ईमेल भेजने के संचालन:

  • "john.doe@example.com को विषय 'Meeting Tomorrow' और हमारी आगामी बैठक के बारे में एक दोस्ताना अनुस्मारक के साथ एक ईमेल भेजें।"
  • "sarah@example.com को प्रोजेक्ट अपडेट के बारे में ईमेल करें, और team@example.com पर टीम को CC करें"
  • "वेलकम टेम्पलेट (uuid b81aabcd-1a1e-41cf-91b6-eca0254b3d96) को new@example.com पर वेरिएबल { name: 'Alex' } के साथ भेजें"
  • "test@example.com को विषय 'Test Template' के साथ एक सैंडबॉक्स ईमेल भेजें ताकि हमारा वेलकम ईमेल कैसा दिखता है इसका पूर्वावलोकन किया जा सके"

ईमेल लॉग (डिलीवरी डीबग करें):

  • "मेरे हाल के भेजे गए ईमेल लॉग सूचीबद्ध करें"
  • "user@example.com को भेजे गए ईमेल के लिए ईमेल लॉग दिखाएँ"
  • "डिलीवरी स्थिति जाँचने के लिए ID abc-123-uuid के लिए ईमेल लॉग संदेश प्राप्त करें"

भेजने के आँकड़े:

  • "जनवरी 2025 के लिए भेजने के आँकड़े प्राप्त करें"
  • "पिछले महीने के लिए डोमेन द्वारा विभाजित डिलीवरी दरें दिखाएँ"
  • "2025-01-01 से 2025-01-31 तक श्रेणी के अनुसार मेरे ईमेल आँकड़े क्या हैं?"

सैंडबॉक्स संचालन:

  • "मेरे सैंडबॉक्स इनबॉक्स से सभी संदेश प्राप्त करें"
  • "मुझे सैंडबॉक्स संदेशों का पहला पृष्ठ दिखाएँ"
  • "मेरे सैंडबॉक्स इनबॉक्स में 'test' युक्त संदेश खोजें"
  • "ID 5159037506 के साथ सैंडबॉक्स संदेश का विवरण दिखाएँ"

टेम्पलेट संचालन:

  • "मेरे Mailtrap खाते में सभी ईमेल टेम्पलेट सूचीबद्ध करें"
  • "'Welcome Email' नामक एक नया ईमेल टेम्पलेट विषय 'Welcome to our platform!' के साथ बनाएँ"
  • "विषय को 'Updated Welcome Message' में बदलने के लिए ID 12345 वाले टेम्पलेट को अपडेट करें"
  • "ID 67890 वाले टेम्पलेट को हटाएँ"

भेजने वाले डोमेन:

  • "मेरे भेजने वाले डोमेन सूचीबद्ध करें"
  • "ID 3938 के साथ भेजने वाला डोमेन प्राप्त करें"
  • "example.com के लिए एक भेजने वाला डोमेन बनाएँ"
  • "भेजने वाले डोमेन 3938 के लिए क्लिक ट्रैकिंग चालू करें"
  • "भेजने वाला डोमेन 3938 हटाएँ"
  • "DNS सेटअप निर्देशों के साथ भेजने वाला डोमेन 3938 प्राप्त करें"
  • "भेजने वाले डोमेन 3938 के लिए कंपनी जानकारी दिखाएँ"
  • "डोमेन 3938 के लिए कंपनी जानकारी Acme Inc, 123 Main St, San Francisco, US, 94105, https://acme.com पर सेट करें"
  • "डोमेन 3938 के लिए कंपनी जानकारी शहर को New York में बदलें"

सप्रेशन:

  • "bounced@example.com के लिए सप्रेशन सूचीबद्ध करें"
  • "डोमेन 3938 के ट्रांज़ैक्शनल स्ट्रीम पर bounced@example.com को सप्रेस करें"
  • "मुझे सभी सप्रेस किए गए ईमेल पते दिखाएँ"
  • "user@example.com को मेरे ईमेल क्यों नहीं मिल रहे हैं?"
  • "user@example.com को सप्रेशन सूची से हटाएँ"

ट्रैकिंग ऑप्ट-आउट:

  • "डोमेन 3938 पर privacy@example.com के लिए ओपन और क्लिक ट्रैकिंग रोकें"
  • "उन सभी को सूचीबद्ध करें जिन्होंने ट्रैकिंग से ऑप्ट-आउट किया"

संपर्क और सूचियाँ:

  • "john.doe@example.com को मेरी न्यूज़लेटर संपर्क सूची में जोड़ें"
  • "मुझे मेरी सभी संपर्क सूचियाँ दिखाएँ"
  • "संपर्क कहाँ से आए यह ट्रैक करने के लिए 'signup_source' नामक एक संपर्क फ़ील्ड बनाएँ"
  • "संपर्क john.doe@example.com को अपडेट करके उनकी योजना 'pro' पर सेट करें"
  • "इस CSV से संपर्क मेरी ऑनबोर्डिंग सूची में आयात करें"
  • "मेरी न्यूज़लेटर सूची से सभी संपर्क निर्यात करें"
  • "संपर्क john.doe@example.com के लिए 'trial_started' इवेंट रिकॉर्ड करें"

वेबहुक:

  • "मेरे खाते पर कॉन्फ़िगर किए गए सभी वेबहुक सूचीबद्ध करें"
  • "बाउंस और स्पैम इवेंट के लिए https://example.com/hooks/mailtrap की ओर इशारा करते हुए एक वेबहुक बनाएँ"
  • "वेबहुक 4821 को अपडेट करके डिलीवरी इवेंट भी भेजें"
  • "वेबहुक 4821 हटाएँ"

खाता और बिलिंग:

  • "इस महीने मेरा वर्तमान बिलिंग उपयोग क्या है?"
  • "मेरी योजना में कितने ईमेल बचे हैं?"
  • "उन सभी को सूचीबद्ध करें जिनके पास इस Mailtrap खाते तक पहुँच है"
  • "मुझे मेरे खाते पर उपलब्ध अनुमति संसाधन दिखाएँ"

API टोकन:

  • "मेरे खाते पर सभी API टोकन सूचीबद्ध करें"
  • "स्टेजिंग वातावरण के लिए एक नया API टोकन बनाएँ"
  • "ID 1234 वाले API टोकन को रीसेट करें"
  • "अप्रयुक्त API टोकन 1234 हटाएँ"

संगठन और उप-खाते:

  • "मेरे संगठन में सभी उप-खाते सूचीबद्ध करें"
  • "क्लाइंट प्रोजेक्ट 'Acme Corp' के लिए एक नया उप-खाता बनाएँ"

उपलब्ध टूल

send-email

Mailtrap के माध्यम से एक ट्रांज़ैक्शनल ईमेल भेजता है। दो परस्पर अनन्य मोड का समर्थन करता है — इनलाइन सामग्री (subject + text/html) या टेम्पलेट-आधारित (template_uuid)।

पैरामीटर:

  • from (वैकल्पिक): प्रेषक के रूप में { email, name? } (एक सादा ईमेल स्ट्रिंग भी रनटाइम पर स्वीकार की जाती है)। यदि प्रदान नहीं किया गया है, तो DEFAULT_FROM_EMAIL का उपयोग किया जाता है।
  • to (वैकल्पिक): प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (सादा ईमेल स्ट्रिंग, या एक एकल गैर-सरणी पता, भी रनटाइम पर स्वीकार किए जाते हैं)। वैकल्पिक यदि cc या bcc प्रदान किया गया है; to / cc / bcc में से कम से कम एक में प्राप्तकर्ता होना चाहिए।
  • cc (वैकल्पिक): CC प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (सादा ईमेल स्ट्रिंग भी रनटाइम पर स्वीकार की जाती हैं)।
  • bcc (वैकल्पिक): BCC प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (सादा ईमेल स्ट्रिंग भी रनटाइम पर स्वीकार की जाती हैं)।
  • subject (सशर्त): ईमेल विषय पंक्ति। इनलाइन भेजने के लिए आवश्यक; जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • text (सशर्त): ईमेल बॉडी टेक्स्ट। इनलाइन भेजने के लिए आवश्यक (html के साथ या उसके बजाय); जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • html (सशर्त): ईमेल बॉडी का HTML संस्करण। इनलाइन भेजने के लिए आवश्यक (text के साथ या उसके बजाय); जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • category (वैकल्पिक): ट्रैकिंग और विश्लेषण के लिए ईमेल श्रेणी। जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • template_uuid (वैकल्पिक): इनलाइन सामग्री के बजाय Mailtrap ईमेल टेम्पलेट का उपयोग करें। सेट होने पर, subject / text / html / category छोड़ा जाना चाहिए (Mailtrap API के अनुसार)।
  • template_variables (वैकल्पिक): template_uuid द्वारा संदर्भित टेम्पलेट में प्रतिस्थापित चर की ऑब्जेक्ट। केवल template_uuid के साथ अनुमति है।

batch-send-transactional-email

एक Mailtrap API कॉल में ट्रांज़ैक्शनल ईमेल का एक बैच भेजता है (डिफ़ॉल्ट भेजने वाला स्ट्रीम)। साझा फ़ील्ड base पर जाते हैं; प्रति-प्राप्तकर्ता ओवरराइड requests[] में जाते हैं। प्रत्येक अनुरोध में to, cc, या bcc के माध्यम से कम से कम एक प्राप्तकर्ता शामिल होना चाहिए। send-email के समान इनलाइन-बनाम-टेम्पलेट परस्पर बहिष्करण — बेस को प्रत्येक अनुरोध के साथ विलय करने के बाद जाँचा जाता है।

पैरामीटर:

  • base (वैकल्पिक): बैच में साझा किए गए फ़ील्ड वाला ऑब्जेक्ट।
    • from (वैकल्पिक): प्रेषक { email, name? } के रूप में (रनटाइम पर एक सादा ईमेल स्ट्रिंग भी स्वीकार की जाती है)। DEFAULT_FROM_EMAIL पर वापस आ जाता है।
    • reply_to (वैकल्पिक): उत्तर-पता।
    • subject / text / html / category (वैकल्पिक, इनलाइन मोड): प्रत्येक अनुरोध के लिए डिफ़ॉल्ट सामग्री।
    • template_uuid / template_variables (वैकल्पिक, टेम्पलेट मोड): डिफ़ॉल्ट टेम्पलेट + चर। इनलाइन फ़ील्ड के साथ परस्पर अनन्य।
    • custom_variables (वैकल्पिक): डिफ़ॉल्ट कस्टम चर (स्ट्रिंग-मान वाले)।
    • headers (वैकल्पिक): डिफ़ॉल्ट कस्टम हेडर।
  • requests (आवश्यक): प्रति-प्राप्तकर्ता संदेशों की गैर-रिक्त सरणी। प्रत्येक प्रविष्टि में है:
    • to (वैकल्पिक): प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (सादा ईमेल स्ट्रिंग, या एक एकल गैर-सरणी पता, रनटाइम पर भी स्वीकार किया जाता है)। यदि cc या bcc प्रदान किया गया है तो वैकल्पिक; to / cc / bcc में से कम से कम एक में प्राप्तकर्ता होना चाहिए।
    • cc, bcc, reply_to (वैकल्पिक)।
    • इनलाइन (subject/text/html/category) या टेम्पलेट (template_uuid/template_variables) ओवरराइड; कोई भी फ़ील्ड छोड़ा गया तो संबंधित base मान पर वापस आ जाता है।
    • custom_variables, headers (वैकल्पिक)।

batch-send-bulk-email

Mailtrap के बल्क-स्ट्रीम API के माध्यम से बल्क ईमेल का एक बैच भेजता है। base + requests[] आकार, सत्यापन, और इनलाइन-बनाम-टेम्पलेट नियम batch-send-transactional-email के समान हैं — एकमात्र अंतर यह है कि यह टूल कॉल को ट्रांज़ैक्शनल एंडपॉइंट के बजाय बल्क एंडपॉइंट के माध्यम से रूट करता है। ऊपर दिए गए पैरामीटर देखें।

list-email-logs

वैकल्पिक पेजिनेशन और फ़िल्टर के साथ भेजे गए ईमेल लॉग (डिलीवरी इतिहास) सूचीबद्ध करता है। IDE से डिलीवरी समस्याओं को डीबग करने के लिए उपयोग करें।

पैरामीटर:

  • search_after (वैकल्पिक): पिछले प्रतिक्रिया के next_page_cursor से पेजिनेशन कर्सर
  • sent_after (वैकल्पिक): ISO 8601 दिनांक/समय; केवल इस समय के बाद भेजे गए लॉग
  • sent_before (वैकल्पिक): ISO 8601 दिनांक/समय; केवल इस समय से पहले भेजे गए लॉग
  • from_email (वैकल्पिक): प्रेषक ईमेल द्वारा फ़िल्टर करें; from_operator के साथ उपयोग करें (डिफ़ॉल्ट: ci_equal)
  • to_email (वैकल्पिक): प्राप्तकर्ता ईमेल द्वारा फ़िल्टर करें; to_operator के साथ उपयोग करें (डिफ़ॉल्ट: ci_equal)
  • status (वैकल्पिक): डिलीवरी स्थिति द्वारा फ़िल्टर करें: delivered, not_delivered, enqueued, opted_out; status_operator के साथ उपयोग करें (डिफ़ॉल्ट: equal)
  • subject (वैकल्पिक): ईमेल विषय द्वारा फ़िल्टर करें; subject_operator के साथ उपयोग करें (डिफ़ॉल्ट: ci_contain)। विषय की उपस्थिति से फ़िल्टर करने के लिए subject_operator: empty/not_empty का उपयोग करें।
  • sending_domain_id (वैकल्पिक): भेजने वाले डोमेन ID (संख्या) द्वारा फ़िल्टर करें; sending_domain_id_operator के साथ उपयोग करें (डिफ़ॉल्ट: equal)
  • sending_stream (वैकल्पिक): स्ट्रीम द्वारा फ़िल्टर करें: transactional या bulk; sending_stream_operator के साथ उपयोग करें (डिफ़ॉल्ट: equal)
  • events (वैकल्पिक): ईवेंट प्रकार द्वारा फ़िल्टर करें: delivery, open, click, bounce, spam, unsubscribe, soft_bounce, reject, suspension; events_operator (include_event / not_include_event) के साथ उपयोग करें
  • clicks_count / opens_count (वैकल्पिक): क्लिक/ओपन गणना द्वारा फ़िल्टर करें; *_operator: equal, greater_than, less_than के साथ उपयोग करें
  • client_ip / sending_ip (वैकल्पिक): IP द्वारा फ़िल्टर करें; *_operator: equal, not_equal, contain, not_contain के साथ उपयोग करें
  • email_service_provider_response (वैकल्पिक): प्रदाता प्रतिक्रिया पाठ द्वारा फ़िल्टर करें; *_operator (ci_contain, आदि) के साथ उपयोग करें
  • email_service_provider (वैकल्पिक): प्रदाता (सटीक) द्वारा फ़िल्टर करें; *_operator: equal, not_equal के साथ उपयोग करें
  • recipient_mx (वैकल्पिक): प्राप्तकर्ता MX द्वारा फ़िल्टर करें; recipient_mx_operator (ci_contain, आदि) के साथ उपयोग करें
  • category (वैकल्पिक): ईमेल श्रेणी द्वारा फ़िल्टर करें; category_operator: equal, not_equal के साथ उपयोग करें

सभी पैरामीटर वैकल्पिक हैं।

get-email-log-message

ID (UUID) द्वारा एक एकल ईमेल लॉग संदेश प्राप्त करता है: एक पठनीय सारांश (से, को, विषय, भेजने का समय, स्थिति, श्रेणी, स्ट्रीम, सहभागिता, डिलीवरी संदर्भ), फिर विस्तृत ईवेंट इतिहास। वैकल्पिक रूप से, include_content: true के साथ, आप संदेश निकाय (HTML और सादा पाठ) भी लोड और दिखा सकते हैं जब Mailtrap एक कच्चा संदेश URL उजागर करता है।

पैरामीटर:

  • message_id (आवश्यक): ईमेल लॉग संदेश का UUID (भेजने की प्रतिक्रिया या list-email-logs से)। संदेश ID खोजने के लिए list-email-logs का उपयोग करें।
  • include_content (वैकल्पिक): जब true, कच्चा EML (यदि raw_message_url उपलब्ध है) प्राप्त करता है और पार्स किए गए HTML और सादा-पाठ निकाय अनुभाग जोड़ता है, show-sandbox-email-message के समान।

get-sending-stats

दिनांक सीमा के लिए ईमेल भेजने के आँकड़े (डिलीवरी, बाउंस, ओपन, क्लिक, स्पैम दरें) प्राप्त करें। वैकल्पिक रूप से डोमेन, श्रेणी, ईमेल सेवा प्रदाता, या दिनांक द्वारा विभाजित करें। संपादक छोड़े बिना डिलीवरी दरें जाँचें।

पैरामीटर:

  • start_date (आवश्यक): आँकड़े सीमा के लिए प्रारंभ दिनांक (YYYY-MM-DD)
  • end_date (आवश्यक): आँकड़े सीमा के लिए समाप्ति दिनांक (YYYY-MM-DD)
  • breakdown (वैकल्पिक): आँकड़ों को कैसे विभाजित करें: aggregated (डिफ़ॉल्ट), by_domain, by_category, by_email_service_provider, या by_date
  • sending_domain_ids (वैकल्पिक): परिणामों को इन भेजने वाले डोमेन ID तक सीमित करें (पूर्णांकों की सरणी)
  • sending_streams (वैकल्पिक): transactional और/या bulk तक सीमित करें (स्ट्रिंग्स की सरणी)
  • categories (वैकल्पिक): इन ईमेल श्रेणियों तक सीमित करें (स्ट्रिंग्स की सरणी)
  • email_service_providers (वैकल्पिक): इन प्रदाताओं तक सीमित करें, जैसे Google, Yahoo, Outlook (स्ट्रिंग्स की सरणी)

create-template

आपके Mailtrap खाते में एक नया ईमेल टेम्पलेट बनाता है।

पैरामीटर:

  • name (आवश्यक): टेम्पलेट का नाम
  • subject (आवश्यक): ईमेल विषय पंक्ति
  • html (या text आवश्यक है): टेम्पलेट की HTML सामग्री
  • text (या html आवश्यक है): टेम्पलेट का सादा पाठ संस्करण
  • category (वैकल्पिक): टेम्पलेट श्रेणी (डिफ़ॉल्ट "General")

list-templates

आपके Mailtrap खाते में सभी ईमेल टेम्पलेट सूचीबद्ध करता है।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

get-template

ID द्वारा एक एकल ईमेल टेम्पलेट प्राप्त करें, जिसमें विषय, श्रेणी, और HTML/पाठ निकाय शामिल हैं।

पैरामीटर:

  • template_id (आवश्यक): प्राप्त करने के लिए टेम्पलेट का ID

update-template

मौजूदा ईमेल टेम्पलेट को अपडेट करता है।

पैरामीटर:

  • template_id (आवश्यक): अपडेट करने के लिए टेम्पलेट का ID
  • name (वैकल्पिक): टेम्पलेट के लिए नया नाम
  • subject (वैकल्पिक): नई ईमेल विषय पंक्ति
  • html (वैकल्पिक): टेम्पलेट की नई HTML सामग्री
  • text (वैकल्पिक): टेम्पलेट का नया सादा पाठ संस्करण
  • category (वैकल्पिक): टेम्पलेट के लिए नई श्रेणी

[!NOTE] अपडेट करने के लिए update-template को कॉल करते समय कम से कम एक अपडेट करने योग्य फ़ील्ड (नाम, विषय, html, पाठ, या श्रेणी) प्रदान की जानी चाहिए।

delete-template

मौजूदा ईमेल टेम्पलेट को हटाता है।

पैरामीटर:

  • template_id (आवश्यक): हटाने के लिए टेम्पलेट का ID

send-sandbox-email

विकास और परीक्षण उद्देश्यों के लिए आपके Mailtrap परीक्षण इनबॉक्स में एक ईमेल भेजता है। वास्तविक प्राप्तकर्ताओं को ईमेल भेजे बिना ईमेल टेम्पलेट का परीक्षण करने के लिए यह एकदम सही है। send-email के समान दो मोड का समर्थन करता है — इनलाइन सामग्री या टेम्पलेट-आधारित (template_uuid)।

पैरामीटर:

  • test_inbox_id (वैकल्पिक): Mailtrap परीक्षण इनबॉक्स ID। जब तक MAILTRAP_TEST_INBOX_ID सेट न हो, आवश्यक; किसी विशिष्ट इनबॉक्स को लक्षित करने के लिए प्रति कॉल पास करें।
  • from (वैकल्पिक): प्रेषक { email, name? } के रूप में (रनटाइम पर एक सादा ईमेल स्ट्रिंग भी स्वीकार की जाती है)। यदि प्रदान नहीं किया गया है, तो DEFAULT_FROM_EMAIL का उपयोग किया जाता है।
  • to (वैकल्पिक): प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (सरणी में सादा ईमेल स्ट्रिंग, या सादा ईमेल की अल्पविराम-पृथक स्ट्रिंग, रनटाइम पर भी स्वीकार की जाती है)। यदि cc या bcc प्रदान किया गया है तो वैकल्पिक; to / cc / bcc में से कम से कम एक में प्राप्तकर्ता होना चाहिए।
  • cc (वैकल्पिक): CC प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (रनटाइम पर सादा ईमेल स्ट्रिंग भी स्वीकार की जाती है)।
  • bcc (वैकल्पिक): BCC प्राप्तकर्ताओं की सरणी { email, name? } ऑब्जेक्ट के रूप में (रनटाइम पर सादा ईमेल स्ट्रिंग भी स्वीकार की जाती है)।
  • subject (सशर्त): ईमेल विषय पंक्ति। इनलाइन भेजने के लिए आवश्यक; जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • text (सशर्त): ईमेल निकाय पाठ। इनलाइन भेजने के लिए (html के साथ या उसके बजाय) आवश्यक; जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • html (सशर्त): ईमेल निकाय का HTML संस्करण। इनलाइन भेजने के लिए (text के साथ या उसके बजाय) आवश्यक; जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • category (वैकल्पिक): ट्रैकिंग के लिए ईमेल श्रेणी। जब template_uuid सेट हो तो छोड़ा जाना चाहिए।
  • template_uuid (वैकल्पिक): इनलाइन सामग्री के बजाय Mailtrap ईमेल टेम्पलेट का उपयोग करें। जब सेट हो, subject / text / html / category छोड़ा जाना चाहिए।
  • template_variables (वैकल्पिक): template_uuid द्वारा संदर्भित टेम्पलेट में प्रतिस्थापित चर का ऑब्जेक्ट। केवल template_uuid के साथ अनुमति है।

batch-send-sandbox-email

एक API कॉल में आपके Mailtrap परीक्षण इनबॉक्स में ईमेल का एक बैच भेजता है, वास्तविक प्राप्तकर्ताओं को वितरित किए बिना। base + requests[] आकार, सत्यापन, और इनलाइन-बनाम-टेम्पलेट नियम batch-send-transactional-email के समान हैं — अंतर यह है कि यह टूल कॉल को एकल परीक्षण इनबॉक्स के लिए सैंडबॉक्स एंडपॉइंट के माध्यम से रूट करता है।

पैरामीटर:

  • sandbox_id (वैकल्पिक): Mailtrap सैंडबॉक्स (परीक्षण इनबॉक्स) ID। जब तक MAILTRAP_SANDBOX_ID सेट न हो, आवश्यक; किसी विशिष्ट सैंडबॉक्स को लक्षित करने के लिए प्रति कॉल पास करें।
  • base (वैकल्पिक), requests (आवश्यक): ऊपर batch-send-transactional-email देखें।

[!NOTE] सैंडबॉक्स टूल के लिए, टूल कॉल में test_inbox_id प्रदान करें या MAILTRAP_TEST_INBOX_ID पर्यावरण चर सेट करें। आप test_inbox_id पास करके प्रति कॉल इनबॉक्स के बीच स्विच कर सकते हैं। sandbox_id लेने वाले टूल पहले MAILTRAP_SANDBOX_ID का उपयोग करते हैं।

get-sandbox-messages

आपके Mailtrap परीक्षण इनबॉक्स से संदेशों की सूची प्राप्त करता है। परीक्षण के दौरान आपके सैंडबॉक्स में कौन से ईमेल प्राप्त हुए हैं, यह जाँचने के लिए उपयोगी है।

पैरामीटर:

  • page (वैकल्पिक): पेजिनेशन के लिए पृष्ठ संख्या (न्यूनतम: 1)
  • last_id (वैकल्पिक): अंतिम संदेश ID का उपयोग करके पेजिनेशन। निर्दिष्ट संदेश ID के बाद के संदेश लौटाता है (न्यूनतम: 1)
  • search (वैकल्पिक): संदेशों को फ़िल्टर करने के लिए खोज क्वेरी

[!NOTE] सभी पैरामीटर वैकल्पिक हैं। यदि कोई प्रदान नहीं किया गया है, तो इनबॉक्स से संदेशों का पहला पृष्ठ लौटाया जाएगा। पारंपरिक पेजिनेशन के लिए page का उपयोग करें, कर्सर-आधारित पेजिनेशन के लिए last_id, या सामग्री द्वारा संदेशों को फ़िल्टर करने के लिए search का उपयोग करें।

show-sandbox-email-message

आपके Mailtrap परीक्षण इनबॉक्स से एक विशिष्ट ईमेल संदेश की विस्तृत जानकारी और सामग्री दिखाता है, जिसमें HTML और पाठ निकाय सामग्री शामिल है।

पैरामीटर:

  • message_id (आवश्यक): प्राप्त करने के लिए सैंडबॉक्स ईमेल संदेश का ID

[!NOTE] संदेशों और उनके ID की सूची प्राप्त करने के लिए पहले get-sandbox-messages का उपयोग करें, फिर किसी विशिष्ट संदेश की पूरी सामग्री देखने के लिए इस टूल का उपयोग करें।

get-sandbox-project

ID द्वारा एक सैंडबॉक्स प्रोजेक्ट प्राप्त करें, जिसमें उसके इनबॉक्स और ईमेल गणनाएँ शामिल हैं।

पैरामीटर:

  • project_id (आवश्यक): प्राप्त करने के लिए प्रोजेक्ट का ID

update-sandbox-project

मौजूदा सैंडबॉक्स प्रोजेक्ट का नाम बदलें।

पैरामीटर:

  • project_id (आवश्यक): अपडेट करने के लिए प्रोजेक्ट का ID
  • name (आवश्यक): प्रोजेक्ट के लिए नया नाम (2–100 वर्ण)

list-sandboxes

सभी प्रोजेक्टों में API टोकन के लिए सुलभ हर सैंडबॉक्स सूचीबद्ध करें।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

mark-sandbox-as-read

सैंडबॉक्स में सभी संदेशों को पढ़े हुए के रूप में चिह्नित करें।

पैरामीटर:

  • sandbox_id (आवश्यक): कार्य करने के लिए सैंडबॉक्स का ID

reset-sandbox-credentials

सैंडबॉक्स के लिए SMTP क्रेडेंशियल्स रीसेट करें। नया यूज़रनेम/पासवर्ड लौटाता है।

पैरामीटर:

  • sandbox_id (आवश्यक): कार्रवाई करने के लिए सैंडबॉक्स की ID

enable-sandbox-email-address

सैंडबॉक्स के लिए ईमेल-द्वारा-प्राप्ति पता सक्षम करें (Mailtrap पते को चालू करता है जो SMTP के माध्यम से सैंडबॉक्स में संदेश पहुंचाता है)।

पैरामीटर:

  • sandbox_id (आवश्यक): कार्रवाई करने के लिए सैंडबॉक्स की ID

reset-sandbox-email-address

सैंडबॉक्स के लिए एक नया ईमेल-द्वारा-प्राप्ति पता जनरेट करें।

पैरामीटर:

  • sandbox_id (आवश्यक): कार्रवाई करने के लिए सैंडबॉक्स की ID

forward-sandbox-message

सैंडबॉक्स संदेश को किसी बाहरी ईमेल पते पर अग्रेषित करें। यह आपके मासिक अग्रेषण कोटा के विरुद्ध गिना जाता है।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): अग्रेषित करने के लिए सैंडबॉक्स संदेश की ID
  • email (आवश्यक): जिस ईमेल पते पर संदेश अग्रेषित करना है

update-sandbox-message

सैंडबॉक्स संदेश को पढ़ा हुआ या अपठित के रूप में चिह्नित करें।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): अपडेट करने के लिए सैंडबॉक्स संदेश की ID
  • is_read (आवश्यक): true पढ़ा हुआ के रूप में चिह्नित करता है, false अपठित के रूप में चिह्नित करता है

delete-sandbox-message

एकल सैंडबॉक्स संदेश हटाएं।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): हटाने के लिए सैंडबॉक्स संदेश की ID

get-sandbox-message-spam-score

सैंडबॉक्स संदेश के लिए SpamAssassin स्पैम रिपोर्ट प्राप्त करें (स्कोर, नियम, पूरी रिपोर्ट)। include_spam_report: true पर show-sandbox-email-message का स्टैंडअलोन विकल्प।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-html-analysis

सैंडबॉक्स संदेश के लिए HTML विश्लेषण रिपोर्ट प्राप्त करें (क्लाइंट संगतता स्कोर, समस्याग्रस्त तत्व)। include_html_analysis: true पर show-sandbox-email-message का स्टैंडअलोन विकल्प।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-headers

सैंडबॉक्स संदेश के लिए पार्स किए गए मेल हेडर प्राप्त करें।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-html

सैंडबॉक्स संदेश का रेंडर किया गया HTML बॉडी प्राप्त करें।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-text

सैंडबॉक्स संदेश का सादा-पाठ बॉडी प्राप्त करें।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-raw

सैंडबॉक्स संदेश के लिए कच्चा, MIME-स्वरूपित संदेश (हेडर + बॉडी) प्राप्त करें।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-eml

संदेश को EML फ़ाइल पेलोड के रूप में रेंडर करके प्राप्त करें (टिकट से जोड़ने या किसी अन्य मेल क्लाइंट में आयात करने के लिए उपयुक्त)।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-message-html-source

सैंडबॉक्स संदेश का अनरेंडर किया गया HTML स्रोत प्राप्त करें (Mailtrap-पक्षीय परिवर्तनों जैसे CID-लिंक पुनर्लेखन से पहले का HTML)।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

list-sandbox-attachments

सैंडबॉक्स संदेश पर सभी अनुलग्नक सूचीबद्ध करें (फ़ाइलनाम, सामग्री प्रकार, आकार, डाउनलोड पथ)।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): सैंडबॉक्स संदेश की ID

get-sandbox-attachment

एकल अनुलग्नक के लिए मेटाडेटा और डाउनलोड URL प्राप्त करें।

पैरामीटर:

  • sandbox_id (वैकल्पिक): सैंडबॉक्स ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
  • message_id (आवश्यक): उस सैंडबॉक्स संदेश की ID जिसमें अनुलग्नक है
  • attachment_id (आवश्यक): लाने के लिए अनुलग्नक की ID

list-sending-domains

भेजने वाले डोमेन और उनकी DNS सत्यापन स्थिति सूचीबद्ध करें।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

get-sending-domain

ID द्वारा भेजने वाला डोमेन और उसकी सत्यापन स्थिति (DNS रिकॉर्ड सहित) प्राप्त करें। वैकल्पिक रूप से include_setup_instructions को true पर सेट करके DNS सेटअप निर्देश शामिल करें।

पैरामीटर:

  • sending_domain_id (आवश्यक): भेजने वाले डोमेन की ID
  • include_setup_instructions (वैकल्पिक): यदि true, तो प्रतिक्रिया में DNS सेटअप निर्देश जोड़ें। डिफ़ॉल्ट: false

create-sending-domain

एक नया भेजने वाला डोमेन बनाएं। निर्माण के बाद, डोमेन सत्यापित करने के लिए DNS रिकॉर्ड जोड़ें (रिकॉर्ड देखने के लिए include_setup_instructions: true के साथ get-sending-domain का उपयोग करें)।

पैरामीटर:

  • domain_name (आवश्यक): डोमेन नाम (जैसे example.com)

update-sending-domain

भेजने वाले डोमेन की ट्रैकिंग और इनबाउंड सेटिंग्स अपडेट करें।

पैरामीटर:

  • sending_domain_id (आवश्यक): भेजने वाले डोमेन की ID
  • open_tracking_enabled (वैकल्पिक): इस डोमेन से भेजे गए ईमेल पर खोलना ट्रैक करें
  • click_tracking_enabled (वैकल्पिक): इस डोमेन से भेजे गए ईमेल में लिंक पर क्लिक ट्रैक करें
  • tracking_opt_out_enabled (वैकल्पिक): ट्रैक किए गए ईमेल में ट्रैकिंग ऑप्ट-आउट लिंक जोड़ें। ओपन या क्लिक ट्रैकिंग की आवश्यकता है
  • auto_unsubscribe_link_enabled (वैकल्पिक): ईमेल में स्वचालित रूप से अनसब्सक्राइब लिंक जोड़ें
  • inbound_enabled (वैकल्पिक): डोमेन को कैच-ऑल के रूप में इनबाउंड इनबॉक्स से जोड़े जाने की अनुमति दें

sending_domain_id के अलावा कम से कम एक सेटिंग प्रदान की जानी चाहिए।

delete-sending-domain

भेजने वाला डोमेन हटाएं।

पैरामीटर:

  • sending_domain_id (आवश्यक): हटाने के लिए भेजने वाले डोमेन की ID

send-sending-domain-setup-instructions

भेजने वाले डोमेन के लिए DNS सेटअप निर्देश किसी दिए गए पते पर ईमेल करें। DevOps टीम के सदस्य को DNS रिकॉर्ड अग्रेषित करने के लिए उपयोगी।

पैरामीटर:

  • sending_domain_id (आवश्यक): भेजने वाले डोमेन की ID
  • email (आवश्यक): DNS सेटअप निर्देश भेजने के लिए ईमेल पता

get-company-info

भेजने वाले डोमेन की कंपनी जानकारी प्राप्त करें, जिसका उपयोग डोमेन अनुपालन सत्यापन के लिए किया जाता है।

पैरामीटर:

  • sending_domain_id (आवश्यक): भेजने वाले डोमेन की ID

create-company-info

भेजने वाले डोमेन की कंपनी जानकारी सेट करें, जो डोमेन अनुपालन सत्यापन के लिए आवश्यक है।

पैरामीटर:

  • sending_domain_id (आवश्यक): भेजने वाले डोमेन की ID
  • name (आवश्यक): कंपनी या व्यक्ति का नाम
  • address (आवश्यक): सड़क का पता
  • city (आवश्यक): शहर
  • country (आवश्यक): देश
  • zip_code (आवश्यक): ZIP या पोस्टल कोड
  • website_url (आवश्यक): कंपनी की वेबसाइट URL
  • phone (वैकल्पिक): फ़ोन नंबर
  • privacy_policy_url (वैकल्पिक): गोपनीयता नीति पृष्ठ का URL
  • terms_of_service_url (वैकल्पिक): सेवा की शर्तें पृष्ठ का URL
  • info_level (वैकल्पिक): business या individual

update-company-info

भेजने वाले डोमेन की कंपनी जानकारी अपडेट करें।

पैरामीटर:

  • sending_domain_id (आवश्यक): भेजने वाले डोमेन की ID
  • create-company-info के सभी फ़ील्ड, सभी वैकल्पिक। कम से कम एक प्रदान किया जाना चाहिए; छोड़े गए फ़ील्ड अपरिवर्तित रहते हैं।

list-suppressions

सप्रेशन सूचीबद्ध या खोजें (हार्ड बाउंस, स्पैम शिकायतें, अनसब्सक्रिप्शन, मैन्युअल आयात)। प्रति कॉल 1000 परिणाम तक लौटाता है।

पैरामीटर:

  • email (वैकल्पिक): ईमेल फ़िल्टर। केवल इस पते से मेल खाने वाले सप्रेशन लौटाता है।

create-suppression

खाते की सप्रेशन सूची में एक ईमेल पता जोड़ें, ताकि Mailtrap उसे डिलीवरी बंद कर दे।

पैरामीटर:

  • email (आवश्यक): सप्रेस करने के लिए ईमेल पता
  • domain_id (आवश्यक): उस भेजने वाले डोमेन की ID जिस पर सप्रेशन लागू होता है
  • sending_stream (आवश्यक): transactional या bulk
  • type (वैकल्पिक): hard bounce, spam complaint, unsubscription या manual import। डिफ़ॉल्ट manual import है

delete-suppression

ID द्वारा सप्रेशन हटाएं। Mailtrap इस ईमेल पर डिलीवरी फिर से शुरू करेगा जब तक कि इसे फिर से सप्रेस न किया जाए।

पैरामीटर:

  • suppression_id (आवश्यक): हटाने के लिए सप्रेशन की ID

list-tracking-opt-outs

ओपन और क्लिक ट्रैकिंग से बाहर किए गए ईमेल पते सूचीबद्ध करें। प्रति कॉल 1000 रिकॉर्ड तक लौटाता है।

पैरामीटर:

  • email (वैकल्पिक): ईमेल फ़िल्टर। केवल इस पते से मेल खाने वाले ऑप्ट-आउट लौटाता है
  • start_time (वैकल्पिक): केवल इस समय या बाद में बनाए गए ऑप्ट-आउट (ISO 8601)
  • end_time (वैकल्पिक): केवल इस समय या पहले बनाए गए ऑप्ट-आउट (ISO 8601)
  • last_id (वैकल्पिक): पेजिनेशन कर्सर — पिछले प्रतिक्रिया से last_id

create-tracking-opt-out

भेजने वाले डोमेन के लिए ओपन और क्लिक ट्रैकिंग से एक ईमेल पता बाहर करें।

पैरामीटर:

  • email (आवश्यक): ट्रैकिंग से ऑप्ट आउट करने के लिए ईमेल पता
  • domain_id (आवश्यक): उस भेजने वाले डोमेन की ID जिस पर ऑप्ट-आउट लागू होता है

delete-tracking-opt-out

ट्रैकिंग ऑप्ट-आउट सूची से एक ईमेल पता हटाएं, ताकि ओपन और क्लिक ट्रैकिंग उस पर फिर से लागू हो।

पैरामीटर:

  • tracking_opt_out_id (आवश्यक): हटाने के लिए ट्रैकिंग ऑप्ट-आउट की ID

list-webhooks

खाते के लिए कॉन्फ़िगर किए गए सभी वेबहुक सूचीबद्ध करें। पूर्ण वेबहुक रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

get-webhook

ID द्वारा एकल वेबहुक प्राप्त करें। पूर्ण वेबहुक रिकॉर्ड JSON के रूप में लौटाता है। ध्यान दें: signing_secret यहाँ नहीं लौटाया जाता है — यह केवल create-webhook की प्रतिक्रिया में उपलब्ध है।

पैरामीटर:

  • webhook_id (आवश्यक): लाने के लिए वेबहुक की ID

create-webhook

वेबहुक बनाएं। प्रतिक्रिया में वेबहुक पेलोड हस्ताक्षर सत्यापित करने के लिए एक signing_secret शामिल है — यह गुप्त कुंजी केवल निर्माण पर लौटाई जाती है, इसलिए इसे अभी संग्रहीत करें। यदि आप इसे खो देते हैं, तो वेबहुक फिर से बनाएं।

पैरामीटर:

  • url (आवश्यक): वह URL जिस पर Mailtrap वेबहुक ईवेंट POST करेगा
  • webhook_type (आवश्यक): "email_sending", "audit_log", या "inbound_receiving"
  • active (वैकल्पिक, बूलियन): डिफ़ॉल्ट true है
  • payload_format (वैकल्पिक): "json" या "jsonlines"। डिफ़ॉल्ट "json" है
  • sending_stream (वैकल्पिक, केवल email_sending): "transactional" या "bulk"
  • event_types (वैकल्पिक, केवल email_sending): delivery, soft_bounce, bounce, suspension, unsubscribe, open, spam_complaint, click, reject की सरणी
  • domain_id (वैकल्पिक, केवल email_sending): इस वेबहुक को स्कोप करने के लिए भेजने वाले डोमेन की ID
  • inbound_inbox_id (वैकल्पिक, केवल inbound_receiving): उस इनबाउंड इनबॉक्स की ID जिससे वेबहुक जुड़ा है; खाते के सभी इनबॉक्स पर लागू करने के लिए छोड़ दें

update-webhook

वेबहुक के परिवर्तनीय फ़ील्ड अपडेट करें। webhook_type, sending_stream, और domain_id निर्माण के बाद बदले नहीं जा सकते — यदि आपको उन्हें बदलने की आवश्यकता है तो वेबहुक फिर से बनाएं।

पैरामीटर:

  • webhook_id (आवश्यक): अपडेट करने के लिए वेबहुक की ID
  • url (वैकल्पिक): नया वेबहुक URL
  • active (वैकल्पिक, बूलियन): वेबहुक सक्षम या अक्षम करें
  • payload_format (वैकल्पिक): "json" या "jsonlines"
  • event_types (वैकल्पिक, केवल email_sending): delivery, soft_bounce, bounce, suspension, unsubscribe, open, spam_complaint, click, reject की सरणी
  • inbound_inbox_id (वैकल्पिक, केवल inbound_receiving): उस इनबाउंड इनबॉक्स की ID जिससे वेबहुक जुड़ा है

delete-webhook

ID द्वारा वेबहुक को स्थायी रूप से हटाएं। हटाए गए वेबहुक रिकॉर्ड को लौटाता है।

पैरामीटर:

  • webhook_id (आवश्यक): हटाने के लिए वेबहुक की ID

get-contact

किसी संपर्क को ID या ईमेल से प्राप्त करें। पूरा संपर्क रिकॉर्ड लौटाता है (सूची सदस्यता, स्थिति, कस्टम फ़ील्ड)।

पैरामीटर:

  • contact_identifier (आवश्यक): संपर्क ID या ईमेल पता

create-contact

नया संपर्क बनाएं।

पैरामीटर:

  • email (आवश्यक): ईमेल पता
  • fields (वैकल्पिक): मर्ज टैग द्वारा कुंजीबद्ध कस्टम फ़ील्ड मान (जैसे first_name)। स्ट्रिंग, संख्या, या बूलियन मान
  • list_ids (वैकल्पिक): इस संपर्क को सदस्यता देने के लिए संपर्क सूचियों की ID
  • unsubscribed (वैकल्पिक, बूलियन): संपर्क को unsubscribed स्थिति में बनाएं

update-contact

ID या ईमेल द्वारा पहचाने गए मौजूदा संपर्क को अपडेट करें। list_ids संपर्क की पूरी सदस्यता सेट को बदल देता है; list_ids_included/list_ids_excluded बाकी को बिना छेड़े जोड़ते/हटाते हैं।

पैरामीटर:

  • contact_identifier (आवश्यक): संपर्क ID या ईमेल
  • email (वैकल्पिक): नया ईमेल पता
  • fields (वैकल्पिक): मर्ज टैग द्वारा कुंजीबद्ध कस्टम फ़ील्ड मान
  • list_ids (वैकल्पिक): सदस्यता सेट को इस सटीक सूची से बदलें
  • list_ids_included (वैकल्पिक): जोड़ने के लिए सूची ID (योगात्मक)
  • list_ids_excluded (वैकल्पिक): हटाने के लिए सूची ID
  • unsubscribed (वैकल्पिक, बूलियन): unsubscribed (सत्य) या subscribed (असत्य) पर सेट करें

delete-contact

किसी संपर्क को ID या ईमेल द्वारा स्थायी रूप से हटाएं। जब API प्रतिक्रिया देता है तो हटाया गया संपर्क रिकॉर्ड लौटाता है; अन्यथा एक पुष्टिकरण पेलोड लौटाता है।

पैरामीटर:

  • contact_identifier (आवश्यक): संपर्क ID या ईमेल

create-contact-event

किसी संपर्क (ID या ईमेल द्वारा) के विरुद्ध एक संपर्क ईवेंट रिकॉर्ड करें। संपर्क-सूची स्वचालन ट्रिगर करने के लिए उपयोग किया जाता है।

पैरामीटर:

  • contact_identifier (आवश्यक): संपर्क ID या ईमेल
  • name (आवश्यक): ईवेंट नाम (स्वचालन ट्रिगर से मेल खाता है)
  • params (आवश्यक): मनमाने key/value जोड़ों की वस्तु। मान स्ट्रिंग, संख्या, बूलियन, या null हो सकते हैं

list-contact-lists

खाते के लिए सभी संपर्क सूचियाँ सूचीबद्ध करें।

पैरामीटर:

  • search (वैकल्पिक): संपर्क सूचियों को नाम से फ़िल्टर करें (केस-असंवेदनशील मिलान), जैसे news

get-contact-list

ID द्वारा एक संपर्क सूची प्राप्त करें।

पैरामीटर:

  • list_id (आवश्यक): प्राप्त करने के लिए संपर्क सूची की ID

create-contact-list

नई संपर्क सूची बनाएं।

पैरामीटर:

  • name (आवश्यक): नई सूची के लिए नाम

update-contact-list

मौजूदा संपर्क सूची का नाम बदलें।

पैरामीटर:

  • list_id (आवश्यक): संपर्क सूची की ID
  • name (आवश्यक): सूची के लिए नया नाम

delete-contact-list

ID द्वारा एक संपर्क सूची को स्थायी रूप से हटाएं।

पैरामीटर:

  • list_id (आवश्यक): हटाने के लिए संपर्क सूची की ID

list-contact-fields

खाते के लिए सभी संपर्क फ़ील्ड परिभाषाएँ सूचीबद्ध करें।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

get-contact-field

ID द्वारा एक संपर्क फ़ील्ड परिभाषा प्राप्त करें।

पैरामीटर:

  • field_id (आवश्यक): संपर्क फ़ील्ड की ID

create-contact-field

नई संपर्क फ़ील्ड परिभाषा बनाएं। merge_tag खाते के भीतर अद्वितीय होना चाहिए और टेम्पलेट चर में प्लेसहोल्डर नाम के रूप में उपयोग किया जाता है।

पैरामीटर:

  • name (आवश्यक): प्रदर्शन नाम (जैसे "पहला नाम")
  • merge_tag (आवश्यक): अद्वितीय प्लेसहोल्डर नाम (जैसे first_name)
  • data_type (आवश्यक): text, number, boolean, date में से एक

update-contact-field

संपर्क फ़ील्ड परिभाषा अपडेट करें। name, merge_tag, और data_type का कोई भी संयोजन बदला जा सकता है।

पैरामीटर:

  • field_id (आवश्यक): संपर्क फ़ील्ड की ID
  • name (वैकल्पिक): नया प्रदर्शन नाम
  • merge_tag (वैकल्पिक): नया मर्ज टैग (अद्वितीय रहना चाहिए)
  • data_type (वैकल्पिक): text, number, boolean, date में से एक

delete-contact-field

ID द्वारा एक संपर्क फ़ील्ड परिभाषा को स्थायी रूप से हटाएं।

पैरामीटर:

  • field_id (आवश्यक): हटाने के लिए संपर्क फ़ील्ड की ID

create-contact-import

संपर्कों का थोक आयात करें। एक आयात कार्य रिकॉर्ड लौटाता है; get-contact-import के साथ इसकी स्थिति की जाँच करें।

पैरामीटर:

  • contacts (आवश्यक): संपर्क प्रविष्टियों की सरणी। प्रत्येक प्रविष्टि की आवश्यकता है:
    • email (आवश्यक): संपर्क ईमेल पता
    • fields (वैकल्पिक): मर्ज टैग द्वारा कुंजीबद्ध कस्टम फ़ील्ड मान (स्ट्रिंग या संख्या मान)
    • list_ids_included (वैकल्पिक): संपर्क को जोड़ने के लिए सूची ID
    • list_ids_excluded (वैकल्पिक): संपर्क को हटाने के लिए सूची ID

get-contact-import

संपर्क आयात कार्य की स्थिति प्राप्त करें (बनाया गया/शुरू किया गया/समाप्त/विफल) बनाए गए/अपडेट किए गए/सीमा-से-अधिक गणनाओं के साथ।

पैरामीटर:

  • import_id (आवश्यक): संपर्क आयात कार्य की ID

create-contact-export

AND-संयुक्त फ़िल्टर के सेट से मेल खाने वाले संपर्कों को निर्यात करें। एक निर्यात कार्य रिकॉर्ड लौटाता है; get-contact-export के साथ स्थिति की जाँच करें ताकि status के finished होने पर डाउनलोड URL प्राप्त हो सके।

पैरामीटर:

  • filters (आवश्यक): फ़िल्टर वस्तुओं की सरणी। प्रत्येक में है:
    • name (आवश्यक): फ़िल्टर करने के लिए फ़ील्ड (list_id, subscription_status, email, आदि)
    • operator (आवश्यक): equal, not_equal, contains, not_contains, is_empty, is_not_empty में से एक
    • value (आवश्यक): तुलना मान (स्ट्रिंग, संख्या, बूलियन, या सरणी)

get-contact-export

संपर्क निर्यात कार्य की स्थिति प्राप्त करें। एक बार status के finished होने पर, url फ़ील्ड में CSV डाउनलोड लिंक होता है।

पैरामीटर:

  • export_id (आवश्यक): संपर्क निर्यात कार्य की ID

list-email-campaigns

खाते के ईमेल अभियानों को सूचीबद्ध करें, नवीनतम पहले, पेज-टोकन पेजिनेशन के साथ। वैकल्पिक रूप से search के साथ नाम से फ़िल्टर करें।

पैरामीटर:

  • token (वैकल्पिक): प्राप्त करने के लिए पृष्ठ संख्या (पेज-टोकन पेजिनेशन)। डिफ़ॉल्ट 1 है
  • per_page (वैकल्पिक): प्रति पृष्ठ अभियानों की संख्या। डिफ़ॉल्ट 50, अधिकतम 100
  • search (वैकल्पिक): अभियानों को नाम से फ़िल्टर करें (केस-असंवेदनशील आंशिक मिलान)

get-email-campaign

ID द्वारा एक ईमेल अभियान प्राप्त करें।

पैरामीटर:

  • email_campaign_id (आवश्यक): ईमेल अभियान की ID

create-email-campaign

नया ईमेल अभियान बनाएं। अभियान हमेशा draft स्थिति में बनाया जाता है; शेड्यूलिंग और शुरू करना अलग उपकरण हैं (schedule-email-campaign, start-email-campaign)।

पैरामीटर:

  • name (आवश्यक): अभियान का नाम
  • domain_id (आवश्यक): अभियान के लिए उपयोग किए गए सत्यापित प्रेषण डोमेन की ID, जैसा कि प्रेषण डोमेन एंडपॉइंट द्वारा लौटाया गया है
  • from_local_part (आवश्यक): प्रेषक पते का स्थानीय भाग (@ से पहले)
  • template_attributes (आवश्यक): इनलाइन ईमेल टेम्पलेट। इसमें है:
    • subject (आवश्यक): ईमेल विषय पंक्ति (अधिकतम 255 वर्ण)। मर्ज टैग का समर्थन करता है, जैसे Hi {{first_name}}
    • body_html (वैकल्पिक): HTML बॉडी (डिज़ाइन)। अभियान को शेड्यूल या शुरू करने से पहले आवश्यक। एक एंकर के माध्यम से अनसब्सक्राइब लिंक शामिल करें जिसका href में __unsubscribe_url__ प्लेसहोल्डर हो
    • body_text (वैकल्पिक): ईमेल बॉडी का सादा-पाठ विकल्प
    • merge_tags (वैकल्पिक): विषय/बॉडी में संदर्भित मर्ज टैग के केवल नाम, जैसे ["first_name"]
  • from_display_name (वैकल्पिक): प्रेषक हेडर में दिखाया गया प्रदर्शन नाम
  • reply_to (वैकल्पिक): उत्तर-पता भाग (display_name, local_part, domain)
  • delivery_mode (वैकल्पिक): rapid (जितनी जल्दी हो सके भेजें) या gradual (delivery_options.emails_per_hour तक सीमित करें)
  • delivery_options (वैकल्पिक): वितरण थ्रॉटलिंग विकल्प (emails_per_hour)
  • contact_list_ids (वैकल्पिक): भेजने के लिए संपर्क सूचियों की ID (शामिल सूचियों के पूर्ण सेट के रूप में माना जाता है)
  • contact_segment_ids (वैकल्पिक): भेजने के लिए संपर्क खंडों की ID (शामिल खंडों के पूर्ण सेट के रूप में माना जाता है)

update-email-campaign

एक draft ईमेल अभियान अपडेट करें। केवल प्रदान किए गए फ़ील्ड बदलते हैं; टेम्पलेट स्थान पर संपादित किया जाता है। किसी अन्य स्थिति में अभियान अपडेट नहीं किए जा सकते।

पैरामीटर:

  • email_campaign_id (आवश्यक): अपडेट करने के लिए ईमेल अभियान की ID
  • अन्य सभी पैरामीटर वैकल्पिक हैं और create-email-campaign के समान हैं (name, domain_id, from_local_part, from_display_name, reply_to, template_attributes, delivery_mode, delivery_options, contact_list_ids, contact_segment_ids)

delete-email-campaign

ID द्वारा एक ईमेल अभियान हटाएं। केवल draft स्थिति में अभियान हटाया जा सकता है।

पैरामीटर:

  • email_campaign_id (आवश्यक): हटाने के लिए ईमेल अभियान की ID

start-email-campaign

एक draft ईमेल अभियान तुरंत भेजना शुरू करें। केवल draft अभियान शुरू किए जा सकते हैं; टेम्पलेट में body_html डिज़ाइन होना चाहिए और दर्शक और सत्यापित प्रेषण डोमेन सेट होना चाहिए।

पैरामीटर:

  • email_campaign_id (आवश्यक): शुरू करने के लिए ईमेल अभियान की ID

schedule-email-campaign

एक draft ईमेल अभियान को भविष्य के समय पर भेजना शुरू करने के लिए शेड्यूल करें। केवल draft अभियान शेड्यूल किए जा सकते हैं।

पैरामीटर:

  • email_campaign_id (आवश्यक): शेड्यूल करने के लिए ईमेल अभियान की ID
  • datetime (आवश्यक): अभियान कब भेजना है (ISO 8601)। भविष्य में होना चाहिए और 1 महीने से अधिक आगे नहीं

cancel-email-campaign

एक scheduled ईमेल अभियान रद्द करें, इसे draft पर लौटाएं। केवल scheduled अभियान रद्द किए जा सकते हैं।

पैरामीटर:

  • email_campaign_id (आवश्यक): रद्द करने के लिए ईमेल अभियान की ID

terminate-email-campaign

एक ईमेल अभियान समाप्त करें जो वर्तमान में भेज रहा है (started, queued, या paused), चालू प्रेषण को रोकते हुए।

पैरामीटर:

  • email_campaign_id (आवश्यक): समाप्त करने के लिए ईमेल अभियान की ID

reset-email-campaign

एक scheduled ईमेल अभियान को draft पर रीसेट करें। केवल scheduled अभियान रीसेट किए जा सकते हैं।

पैरामीटर:

  • email_campaign_id (आवश्यक): रीसेट करने के लिए ईमेल अभियान की ID

get-email-campaign-stats

एक ईमेल अभियान के लिए एकत्रित प्रदर्शन आँकड़े प्राप्त करें (वितरण, खोलने, क्लिक, बाउंस, स्पैम शिकायतों और अनसब्सक्रिप्शन के लिए गणना और दरें)।

पैरामीटर:

  • email_campaign_id (आवश्यक): ईमेल अभियान की ID
  • start_date (वैकल्पिक): एकत्रीकरण विंडो की शुरुआत (समावेशी), YYYY-MM-DD। डिफ़ॉल्ट उस दिन से है जब अभियान अंतिम बार शुरू किया गया था
  • end_date (वैकल्पिक): एकत्रीकरण विंडो का अंत (समावेशी), YYYY-MM-DD। डिफ़ॉल्ट वर्तमान तिथि है

list-accounts

Mailtrap खातों को सूचीबद्ध करें जिन तक वर्तमान API टोकन पहुंच सकता है, प्रत्येक खाते के एक्सेस स्तरों के साथ।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

get-billing-usage

खाते के लिए वर्तमान बिलिंग चक्र उपयोग प्राप्त करें: भेजने और परीक्षण योजनाएँ, सीमाएँ और वर्तमान गणनाएँ।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

list-account-accesses

खाते के लिए खाता पहुंच (उपयोगकर्ता, निमंत्रण, API टोकन) सूचीबद्ध करें। वैकल्पिक फ़िल्टर परिणाम को विशिष्ट संसाधनों तक सीमित करते हैं। खाता व्यवस्थापक/स्वामी अनुमतियों की आवश्यकता है।

पैरामीटर:

  • domain_uuids (वैकल्पिक): प्रेषण डोमेन UUID द्वारा फ़िल्टर करें (स्ट्रिंग की सरणी)
  • inbox_ids (वैकल्पिक): सैंडबॉक्स इनबॉक्स ID द्वारा फ़िल्टर करें (स्ट्रिंग की सरणी)
  • project_ids (वैकल्पिक): सैंडबॉक्स प्रोजेक्ट ID द्वारा फ़िल्टर करें (स्ट्रिंग की सरणी)

remove-account-access

ID द्वारा एक खाता पहुंच हटाएं। User निर्दिष्टकर्ताओं के लिए यह उनकी अनुमतियों को रद्द करता है; Invite या ApiToken निर्दिष्टकर्ताओं के लिए यह निर्दिष्टकर्ता को पूरी तरह से हटा देता है। व्यवस्थापक/स्वामी की आवश्यकता है।

पैरामीटर:

  • account_access_id (आवश्यक): हटाने के लिए एक्सेस रिकॉर्ड की ID

get-permission-resources

सभी संसाधन (इनबॉक्स, प्रोजेक्ट, डोमेन, बिलिंग, खाता) प्राप्त करें जिन तक API टोकन के पास व्यवस्थापक पहुंच है, पदानुक्रम द्वारा नेस्टेड।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

bulk-update-permissions

एकल खाता एक्सेस के लिए अनुमतियों को थोक में बनाएं, अपडेट करें, या हटाएं। मौजूदा (resource_type, resource_id) जोड़े अपडेट किए जाते हैं; नए बनाए जाते हैं। किसी प्रविष्टि को हटाने के लिए destroy: true सेट करें।

पैरामीटर:

  • account_access_id (आवश्यक): लक्षित खाता एक्सेस आईडी
  • permissions (आवश्यक): अनुमति प्रविष्टियों की सरणी। प्रत्येक में:
    • resource_id (आवश्यक): संसाधन आईडी (संख्या या स्ट्रिंग)
    • resource_type (आवश्यक): account, project, inbox, domain, billing में से एक
    • access_level (वैकल्पिक): admin/100 या viewer/10
    • destroy (वैकल्पिक, बूलियन): सत्य होने पर, इसे बनाने/अपडेट करने के बजाय यह अनुमति हटा दी जाती है

list-api-tokens

खाते के लिए सभी API टोकन सूचीबद्ध करें।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

create-api-token

एक नया API टोकन बनाएं। प्रतिक्रिया में गुप्त token मान शामिल है — यह एकमात्र समय है जब पूरा टोकन लौटाया जाता है, इसलिए इसे तुरंत संग्रहीत करें। यदि आप इसे खो देते हैं, तो टोकन को फिर से बनाएं।

पैरामीटर:

  • name (आवश्यक): टोकन के लिए प्रदर्शन नाम
  • expires_at (वैकल्पिक): ISO 8601 दिनांक-समय के रूप में टोकन समाप्ति। सर्वर डिफ़ॉल्ट (1 वर्ष) के लिए छोड़ दें; कभी समाप्त न होने वाले टोकन के लिए स्पष्ट null पास करें। पिछले मान या 5 वर्ष से अधिक आगे के मान अस्वीकार किए जाते हैं
  • resources (वैकल्पिक): टोकन को सीमित करने के लिए संसाधन अनुमतियों की सरणी। प्रत्येक प्रविष्टि में:
    • resource_type (आवश्यक): account, project, inbox, domain, billing में से एक
    • resource_id (आवश्यक): संसाधन की आईडी
    • access_level (आवश्यक): 100 (व्यवस्थापक) या 10 (दर्शक)

get-api-token

आईडी द्वारा एक API टोकन प्राप्त करें। केवल मेटाडेटा लौटाता है — गुप्त टोकन मान यहाँ नहीं लौटाया जाता है (केवल create-api-token / reset-api-token से)।

पैरामीटर:

  • api_token_id (आवश्यक): API टोकन की आईडी

reset-api-token

आईडी द्वारा एक API टोकन रीसेट (रोटेट) करें। प्रतिक्रिया में नया गुप्त token मान शामिल है — केवल इस कॉल पर लौटाया जाता है, इसलिए इसे तुरंत संग्रहीत करें। पिछला टोकन अमान्य कर दिया गया है।

पैरामीटर:

  • api_token_id (आवश्यक): रीसेट करने के लिए API टोकन की आईडी
  • expires_at (वैकल्पिक): ISO 8601 दिनांक-समय के रूप में नए टोकन के लिए समाप्ति। सर्वर डिफ़ॉल्ट (1 वर्ष) के लिए छोड़ दें; कभी समाप्त न होने वाले टोकन के लिए स्पष्ट null पास करें। पिछले मान या 5 वर्ष से अधिक आगे के मान अस्वीकार किए जाते हैं

delete-api-token

आईडी द्वारा एक API टोकन को स्थायी रूप से हटाएं। हटाने के बाद टोकन प्रमाणित नहीं हो सकता।

पैरामीटर:

  • api_token_id (आवश्यक): हटाने के लिए API टोकन की आईडी

list-sub-accounts

संगठन में उप-खाते सूचीबद्ध करें। MAILTRAP_ORGANIZATION_ID env var और उप-खाता प्रबंधन अनुमतियों की आवश्यकता है।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

create-sub-account

संगठन के अंतर्गत एक नया उप-खाता बनाएं। MAILTRAP_ORGANIZATION_ID env var और उप-खाता प्रबंधन अनुमतियों की आवश्यकता है।

पैरामीटर:

  • name (आवश्यक): नए उप-खाते के लिए प्रदर्शन नाम

list-inbound-folders

खाते में सभी इनबाउंड फ़ोल्डर सूचीबद्ध करें। एक स्वरूपित सारांश लौटाता है।

पैरामीटर:

  • कोई पैरामीटर आवश्यक नहीं

get-inbound-folder

आईडी द्वारा एक एकल इनबाउंड फ़ोल्डर प्राप्त करें। पूर्ण फ़ोल्डर रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी

create-inbound-folder

एक नया इनबाउंड फ़ोल्डर बनाएं।

पैरामीटर:

  • name (आवश्यक): फ़ोल्डर का नाम

update-inbound-folder

एक इनबाउंड फ़ोल्डर का नाम बदलें।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी
  • name (आवश्यक): नया फ़ोल्डर नाम

delete-inbound-folder

एक इनबाउंड फ़ोल्डर को उसके सभी इनबॉक्स के साथ स्थायी रूप से हटाएं।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी

list-inbound-inboxes

एक इनबाउंड फ़ोल्डर में सभी इनबॉक्स सूचीबद्ध करें। एक स्वरूपित सारांश लौटाता है।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी

get-inbound-inbox

आईडी द्वारा एक एकल इनबाउंड इनबॉक्स प्राप्त करें। पूर्ण इनबॉक्स रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी
  • inbox_id (आवश्यक): इनबॉक्स की आईडी

create-inbound-inbox

एक फ़ोल्डर में एक नया इनबाउंड इनबॉक्स बनाएं।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी
  • name (आवश्यक): इनबॉक्स का नाम
  • domain_id (वैकल्पिक): कस्टम भेजने वाले डोमेन से संलग्न करें (कैच-ऑल इनबॉक्स)। Mailtrap-होस्टेड इनबॉक्स के लिए छोड़ दें

update-inbound-inbox

एक इनबाउंड इनबॉक्स का नाम बदलें।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी
  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • name (आवश्यक): नया इनबॉक्स नाम

delete-inbound-inbox

एक इनबाउंड इनबॉक्स को स्थायी रूप से हटाएं।

पैरामीटर:

  • folder_id (आवश्यक): इनबाउंड फ़ोल्डर की आईडी
  • inbox_id (आवश्यक): इनबॉक्स की आईडी

list-inbound-messages

एक इनबाउंड इनबॉक्स में प्राप्त संदेश सूचीबद्ध करें (कर्सर-पृष्ठांकित)। अधिक परिणाम मौजूद होने पर अगले-पृष्ठ संकेत के साथ एक स्वरूपित सारांश लौटाता है।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • last_id (वैकल्पिक): पिछले प्रतिक्रिया के last_id से पृष्ठांकन कर्सर

get-inbound-message

एक एकल इनबाउंड संदेश को उसके पूर्ण निकाय और अनुलग्नक डाउनलोड URL के साथ प्राप्त करें। पूर्ण संदेश रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • message_id (आवश्यक): संदेश की आईडी

delete-inbound-message

एक इनबाउंड संदेश को स्थायी रूप से हटाएं।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • message_id (आवश्यक): संदेश की आईडी

reply-to-inbound-message

एक इनबाउंड संदेश का उत्तर दें (मूल प्रेषक को भेजता है)। एक वास्तविक ईमेल भेजता है। पते एक सादे ईमेल स्ट्रिंग या { email, name? } स्वीकार करते हैं।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • message_id (आवश्यक): उत्तर देने के लिए संदेश की आईडी
  • text / html (कम से कम एक अनुशंसित): उत्तर निकाय
  • from (वैकल्पिक): प्रेषक। Mailtrap-होस्टेड इनबॉक्स के लिए अस्वीकृत; कस्टम-डोमेन इनबॉक्स के लिए आवश्यक
  • cc / bcc / reply_to (वैकल्पिक): अतिरिक्त पते
  • category (वैकल्पिक): संदेश श्रेणी
  • attachments (वैकल्पिक): { content (base64), filename, type?, disposition?, content_id? } की सरणी
  • headers / custom_variables (वैकल्पिक): स्ट्रिंग मानों की वस्तुएं

reply-all-to-inbound-message

एक इनबाउंड संदेश का उत्तर दें और मूल के अन्य प्राप्तकर्ताओं की प्रतिलिपि बनाएं। एक वास्तविक ईमेल भेजता है। reply-to-inbound-message के समान पैरामीटर।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • message_id (आवश्यक): उत्तर देने के लिए संदेश की आईडी
  • साथ ही reply-to-inbound-message के समान वैकल्पिक भेजने वाले फ़ील्ड

forward-inbound-message

एक इनबाउंड संदेश को नए प्राप्तकर्ताओं को अग्रेषित करें। एक वास्तविक ईमेल भेजता है।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • message_id (आवश्यक): अग्रेषित करने के लिए संदेश की आईडी
  • to (आवश्यक): कम से कम एक प्राप्तकर्ता (सादा ईमेल स्ट्रिंग या { email, name? }, या एक सरणी)
  • साथ ही reply-to-inbound-message के समान वैकल्पिक भेजने वाले फ़ील्ड

list-inbound-threads

एक इनबाउंड इनबॉक्स में वार्तालाप थ्रेड सूचीबद्ध करें (कर्सर-पृष्ठांकित)। अधिक परिणाम मौजूद होने पर अगले-पृष्ठ संकेत के साथ एक स्वरूपित सारांश लौटाता है।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • last_id (वैकल्पिक): पिछले प्रतिक्रिया के last_id से पृष्ठांकन कर्सर

get-inbound-thread

एक एकल इनबाउंड थ्रेड को उसके संदेशों के साथ एम्बेडेड (सबसे पुराना पहले) प्राप्त करें। पूर्ण थ्रेड रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • thread_id (आवश्यक): थ्रेड की आईडी

delete-inbound-thread

एक इनबाउंड थ्रेड को स्थायी रूप से हटाएं।

पैरामीटर:

  • inbox_id (आवश्यक): इनबॉक्स की आईडी
  • thread_id (आवश्यक): थ्रेड की आईडी

विकास

  1. रिपॉजिटरी को क्लोन करें:
git clone https://github.com/mailtrap/mailtrap-mcp.git
cd mailtrap-mcp
  1. निर्भरताएं स्थापित करें:
npm install

Claude Desktop या Cursor के साथ कॉन्फ़िगरेशन

[!TIP] Setup अनुभाग में कॉन्फ़िग फ़ाइल का स्थान देखें।

निम्नलिखित कॉन्फ़िगरेशन जोड़ें:

{
  "mcpServers": {
    "mailtrap": {
      "command": "node",
      "args": ["/path/to/mailtrap-mcp/dist/index.js"],
      "env": {
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
      }
    }
  }
}

यदि आप Node.js प्रबंधित करने के लिए asdf का उपयोग कर रहे हैं तो आपको निष्पादन योग्य के लिए पूर्ण पथ का उपयोग करना चाहिए:

(Mac के लिए उदाहरण)

{
  "mcpServers": {
    "mailtrap": {
      "command": "/Users/<username>/.asdf/shims/node",
      "args": ["/path/to/mailtrap-mcp/dist/index.js"],
      "env": {
        "PATH": "/Users/<username>/.asdf/shims:/usr/bin:/bin",
        "ASDF_DIR": "/opt/homebrew/opt/asdf/libexec",
        "ASDF_DATA_DIR": "/Users/<username>/.asdf",
        "ASDF_NODEJS_VERSION": "20.6.1",
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
      }
    }
  }
}

VS Code

[!TIP] Setup अनुभाग में कॉन्फ़िग फ़ाइल का स्थान देखें।

{
  "mcp": {
    "servers": {
      "mailtrap": {
        "command": "node",
        "args": ["/path/to/mailtrap-mcp/dist/index.js"],
        "env": {
          "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
          "DEFAULT_FROM_EMAIL": "your_sender@example.com",
          "MAILTRAP_ACCOUNT_ID": "your_account_id",
          "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
        }
      }
    }
  }
}

परीक्षण

वास्तविक Mailtrap के विरुद्ध उपकरण चलाना

वास्तविक Mailtrap खाते के विरुद्ध किसी उपकरण को अंत-से-अंत तक चलाने के दो तरीके हैं: इंटरैक्टिव अन्वेषण के लिए MCP Inspector ब्राउज़र UI, या शेल से एक-शॉट कॉल के लिए इसका CLI मोड।

दोनों के लिए बंडल पहले बनाया जाना आवश्यक है:

npm run build

और MAILTRAP_API_TOKEN + MAILTRAP_ACCOUNT_ID आपके शेल में निर्यात किए गए (mcp:cli स्क्रिप्ट दोनों को स्पॉन किए गए सर्वर पर अग्रेषित करता है)।

ब्राउज़र UI

npm run dev

Inspector http://localhost:6274 जैसा URL प्रिंट करता है। इसे खोलें, Tools टैब पर स्विच करें, एक उपकरण चुनें (जैसे get-template), पैरामीटर को JSON के रूप में भरें, और Run दबाएं। Mailtrap प्रतिक्रिया नीचे पैनल में दिखाई देती है।

CLI

UI के बिना एक-शॉट कॉल के लिए, npm run mcp:cli का उपयोग करें। Inspector के CLI फ़्लैग को -- के बाद पास करें ताकि npm उन्हें शब्दशः अग्रेषित करे:

# List all tools
npm run mcp:cli -- --method tools/list

# Call a tool — flags after the `--`
npm run mcp:cli -- \
  --method tools/call \
  --tool-name get-template \
  --tool-arg template_id=12345

# Multiple --tool-arg flags for tools with several params
npm run mcp:cli -- \
  --method tools/call \
  --tool-name send-sending-domain-setup-instructions \
  --tool-arg sending_domain_id=3938 \
  --tool-arg email=devops@example.com

MCPB सर्वर चलाना

# Run the MCPB server directly
node dist/mcpb-server.js

# Or use the provided binary
mailtrap-mcpb-server

[!TIP] MCP Inspector के साथ विकास के लिए:

npm run dev:mcpb

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

यह सर्वर MCP सम्मेलनों के साथ संरेखित संरचित त्रुटि प्रबंधन का उपयोग करता है:

  • VALIDATION_ERROR: इनपुट सत्यापन विफलताएं
  • CONFIGURATION_ERROR: लापता या अमान्य कॉन्फ़िगरेशन
  • EXECUTION_ERROR: रनटाइम निष्पादन त्रुटियां
  • TIMEOUT: ऑपरेशन टाइमआउट (30 सेकंड डिफ़ॉल्ट)

त्रुटियों में कार्रवाई योग्य संदेश शामिल हैं और संरचित रूप में लॉग किए जाते हैं।

सुरक्षा

  • Zod स्कीमा के माध्यम से इनपुट सत्यापित
  • पर्यावरण चर सुरक्षित रूप से संभाले जाते हैं
  • ऑपरेशनों पर टाइमआउट सुरक्षा (30 सेकंड)
  • त्रुटि आउटपुट में संवेदनशील विवरण साफ़ किए जाते हैं

लॉगिंग

स्तरों के साथ संरचित JSON लॉग: INFO, WARN, ERROR, DEBUG।

DEBUG=true सेट करके डीबग लॉगिंग सक्षम करें।

# Example: enable debug logging
DEBUG=true node dist/mcpb-server.js

महत्वपूर्ण: सर्वर stderr पर लॉग लिखता है ताकि stdout JSON-RPC फ्रेम के लिए आरक्षित रहे। यह होस्ट को इंटरलीव किए गए लॉग के कारण JSON पार्सिंग त्रुटियों का सामना करने से रोकता है।

jq का उपयोग करके लॉग विश्लेषण उदाहरण:

# Filter error logs
node dist/mcpb-server.js 2>&1 | jq 'select(.level == "error")'

# Filter debug logs
node dist/mcpb-server.js 2>&1 | jq 'select(.level == "debug")'

समस्या निवारण

सामान्य समस्याएं:

  1. लापता API टोकन: सुनिश्चित करें कि MAILTRAP_API_TOKEN सेट है
  2. सैंडबॉक्स काम नहीं कर रहा: टूल कॉल में test_inbox_id प्रदान करें या MAILTRAP_TEST_INBOX_ID env सेट करें
  3. टाइमआउट त्रुटियां: नेटवर्क कनेक्टिविटी और Mailtrap API स्थिति जांचें
  4. सत्यापन त्रुटियां: सुनिश्चित करें कि सभी आवश्यक फ़ील्ड प्रदान किए गए हैं

योगदान

बग रिपोर्ट और पुल अनुरोध GitHub पर स्वागत हैं। यह परियोजना सहयोग के लिए एक सुरक्षित, स्वागत योग्य स्थान होने का इरादा रखती है, और योगदानकर्ताओं से आचार संहिता का पालन करने की अपेक्षा की जाती है।

लाइसेंस

पैकेज MIT License की शर्तों के तहत ओपन सोर्स के रूप में उपलब्ध है।

आचार संहिता

Mailtrap परियोजना के कोडबेस, मुद्दा ट्रैकर, चैट रूम और मेलिंग सूचियों में बातचीत करने वाले सभी लोगों से आचार संहिता का पालन करने की अपेक्षा की जाती है।