Mailtrap

आधिकारिक 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 खाता प्रबंधन से अपना Account ID प्राप्त करें
5. Node.js 22 या बाद का संस्करण इंस्टॉल करें, जब तक कि आप Docker इमेज न चलाएँ

आवश्यक Environment Variables:

• MAILTRAP_API_TOKEN - सभी सुविधाओं के लिए आवश्यक
• MAILTRAP_ACCOUNT_ID - templates, get-sending-stats, email logs, sandbox list/show, domains और suppressions के लिए आवश्यक। केवल send tools (send-email, send-sandbox-email और batch-send-* tools), email campaign tools, get-marketing-stats, company info tools, tracking opt-out tools और list-accounts के लिए वैकल्पिक।

वैकल्पिक (इन्हें tool parameters के रूप में भी दिया जा सकता है):

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

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

Docker

Docker MCP Catalog इमेज के साथ सर्वर को stdio पर चलाएँ:

docker run --rm -i \
  -e MAILTRAP_API_TOKEN="${MAILTRAP_API_TOKEN}" \
  -e MAILTRAP_ACCOUNT_ID="${MAILTRAP_ACCOUNT_ID}" \
  -e DEFAULT_FROM_EMAIL="${DEFAULT_FROM_EMAIL}" \
  -e MAILTRAP_SANDBOX_ID="${MAILTRAP_SANDBOX_ID}" \
  -e MAILTRAP_ORGANIZATION_ID="${MAILTRAP_ORGANIZATION_ID}" \
  -e MAILTRAP_ORGANIZATION_API_TOKEN="${MAILTRAP_ORGANIZATION_API_TOKEN}" \
  mcp/mailtrap

आवश्यक और वैकल्पिक environment variables के लिए आवश्यकताएँ देखें।

इस repository से build करने के लिए: docker build -t mcp/mailtrap .

Smithery CLI

Smithery MCP सर्वरों के लिए एक registry और installer है, जो AI क्लाइंट के साथ काम करता है।

प्रकाशित सर्वर (mailtrap/mailtrap-mcp) को किसी स्थानीय क्लाइंट में इंस्टॉल करें (ज़रूरत के अनुसार क्लाइंट का नाम बदलें):

npx -y smithery mcp add mailtrap/mailtrap-mcp --client claude

अन्य क्लाइंट (cursor, windsurf आदि) और अपडेट प्रकाशित करने के लिए Smithery CLI दस्तावेज़ देखें।

सेटअप

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_SANDBOX_ID": "your_sandbox_id"
      }
    }
  }
}

अगर आप Node.js प्रबंधित करने के लिए asdf का उपयोग कर रहे हैं, तो आपको executable का absolute path देना होगा (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": "22.14.0",
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_SANDBOX_ID": "your_sandbox_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

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

Command Palette में चलाएँ: Preferences: Open User Settings (JSON)

फिर, settings फ़ाइल में यह कॉन्फ़िगरेशन जोड़ें:

{
  "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_SANDBOX_ID": "your_sandbox_id"
        }
      }
    }
  }
}

[!TIP] "env" सेक्शन बदलने के बाद अपने MCP सर्वर को रीस्टार्ट करना न भूलें।

MCP Bundle (MCPB)

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

# 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

इससे mailtrap-mcp.mcpb बनता है। स्क्रिप्ट dist/, manifest.json, icon.png और लाइसेंस को mcpb-build/ में कॉपी करती है, वहाँ production dependencies इंस्टॉल करती है और केवल उसी डायरेक्टरी को पैक करती है। repository के root से mcpb pack . न चलाएँ।

उपयोग

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

ईमेल भेजने के ऑपरेशन:

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

ईमेल लॉग (डिलीवरी की जाँच):

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

आँकड़े:

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

Sandbox ऑपरेशन:

• "मेरे sandbox के सभी संदेश प्राप्त करें"
• "sandbox संदेशों का पहला पेज दिखाएँ"
• "मेरे sandbox में 'test' वाले संदेश खोजें"
• "प्रोजेक्ट 42 में 'QA' नाम का sandbox बनाएँ और उसके SMTP क्रेडेंशियल दें"
• "sandbox 1234 के सभी संदेश हटाएँ"
• "ID 5159037506 वाले sandbox संदेश का विवरण दिखाएँ"

टेम्पलेट ऑपरेशन:

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

डोमेन:

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

Suppressions:

• "bounced@example.com के लिए suppressions की सूची दिखाएँ"
• "डोमेन 3938 की transactional stream पर bounced@example.com को suppress करें"
• "सभी suppressed ईमेल पतों की सूची दिखाएँ"
• "user@example.com को मेरे ईमेल क्यों नहीं मिल रहे हैं?"
• "user@example.com को suppression list से हटाएँ"

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

• "डोमेन 3938 पर privacy@example.com के लिए opens और clicks की ट्रैकिंग बंद करें"
• "ट्रैकिंग से ऑप्ट-आउट करने वाले सभी लोगों की सूची दिखाएँ"

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

• "john.doe@example.com को मेरी newsletter contact list में जोड़ें"
• "मेरी सभी contact lists दिखाएँ"
• "संपर्क कहाँ से आए, यह ट्रैक करने के लिए 'signup_source' नाम का contact field बनाएँ"
• "john.doe@example.com के संपर्क को अपडेट करके उनका plan 'pro' पर सेट करें"
• "इस CSV से संपर्कों को मेरी onboarding list में आयात करें"
• "मेरी newsletter list के सभी संपर्क निर्यात करें"
• "john.doe@example.com संपर्क के लिए 'trial_started' इवेंट रिकॉर्ड करें"

वेबहुक:

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

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

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

API टोकन:

• "मेरे खाते के सभी API टोकन की सूची दिखाएँ"
• "staging environment के लिए नया API टोकन बनाएँ"
• "ID 1234 वाला API टोकन रीसेट करें"
• "बिना उपयोग वाला API टोकन 1234 हटाएँ"

संगठन और सब-अकाउंट:

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

नाम बदले गए tools

Mailtrap अब test inboxes को sandboxes और sending domains को domains कहता है, और tools के नाम भी उसी के अनुसार हैं। पुराने नाम अब tool list में नहीं दिखते, लेकिन उन्हें कॉल करना अब भी काम करता है और stderr में अप्रचलन की चेतावनी लॉग करता है। इन्हें भविष्य की किसी major release में हटा दिया जाएगा।

MCP क्लाइंट और agent frameworks, allow, deny और filter सूचियों का मिलान विज्ञापित tool name से करते हैं। इसलिए हर tool की प्रविष्टियों को नए नामों पर बदलें: delete-sending-domain के लिए deny प्रविष्टि अब delete-domain को ब्लॉक नहीं करती।

पुराना नाम	नया नाम
create-sandbox-inbox	create-sandbox
get-sandbox-inbox	get-sandbox
update-sandbox-inbox	update-sandbox
delete-sandbox-inbox	delete-sandbox
clean-sandbox-inbox	clean-sandbox
list-sending-domains	list-domains
get-sending-domain	get-domain
create-sending-domain	create-domain
update-sending-domain	update-domain
delete-sending-domain	delete-domain
send-sending-domain-setup-instructions	send-domain-setup-instructions
sending_domain_id डोमेन और कंपनी जानकारी वाले tools का param	domain_id
MAILTRAP_TEST_INBOX_ID env var	MAILTRAP_SANDBOX_ID

API फ़ील्ड से मेल खाने वाले फ़िल्टर के नाम वही रहते हैं: sending_domain_id, list-email-logs पर और stats tools पर sending_domain_ids।

उपलब्ध Tools

send-email

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

पैरामीटर:

• from (वैकल्पिक): प्रेषक, { email, name? } के रूप में (रनटाइम पर केवल ईमेल स्ट्रिंग भी स्वीकार की जाती है)। यदि प्रदान नहीं किया जाता है, तो DEFAULT_FROM_EMAIL का उपयोग किया जाता है।
• to (वैकल्पिक): { email, name? } ऑब्जेक्ट के रूप में प्राप्तकर्ताओं की ऐरे (रनटाइम पर केवल ईमेल स्ट्रिंग या एक गैर-ऐरे पता भी स्वीकार किया जाता है)। यदि cc या bcc प्रदान किया गया है, तो यह वैकल्पिक है; to / cc / bcc में से कम-से-कम एक में प्राप्तकर्ता होना चाहिए।
• cc (वैकल्पिक): { email, name? } ऑब्जेक्ट के रूप में CC प्राप्तकर्ताओं की ऐरे (रनटाइम पर केवल ईमेल स्ट्रिंग भी स्वीकार की जाती है)।
• bcc (वैकल्पिक): { email, name? } ऑब्जेक्ट के रूप में BCC प्राप्तकर्ताओं की ऐरे (रनटाइम पर केवल ईमेल स्ट्रिंग भी स्वीकार की जाती है)।
• subject (सशर्त): ईमेल की विषय पंक्ति। इनलाइन भेजने के लिए आवश्यक; template_uuid सेट होने पर इसे छोड़ना होगा।
• text (सशर्त): ईमेल का मुख्य टेक्स्ट। इनलाइन भेजने के लिए आवश्यक (html के साथ या उसके बजाय); template_uuid सेट होने पर इसे छोड़ना होगा।
• html (सशर्त): ईमेल के मुख्य भाग का HTML संस्करण। इनलाइन भेजने के लिए आवश्यक (text के साथ या उसके बजाय); template_uuid सेट होने पर इसे छोड़ना होगा।
• category (वैकल्पिक): ट्रैकिंग और विश्लेषण के लिए ईमेल श्रेणी। template_uuid सेट होने पर इसे छोड़ना होगा।
• template_uuid (वैकल्पिक): इनलाइन सामग्री के बजाय Mailtrap ईमेल टेम्पलेट का उपयोग करें। सेट होने पर, Mailtrap API के अनुसार subject / text / html / category को छोड़ना होगा।
• 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 के bulk-stream API के ज़रिए बल्क ईमेल का बैच भेजता है। batch-send-transactional-email जैसे ही base + requests[] संरचना, सत्यापन और इनलाइन-बनाम-टेम्पलेट नियम लागू होते हैं — केवल इतना अंतर है कि यह टूल कॉल को ट्रांज़ैक्शनल एंडपॉइंट के बजाय बल्क एंडपॉइंट के ज़रिए भेजता है। ऊपर दिए गए पैरामीटर देखें।

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 के साथ, Mailtrap द्वारा रॉ संदेश URL उपलब्ध कराने पर आप संदेश का मुख्य भाग (HTML और सादा टेक्स्ट) भी लोड करके दिखा सकते हैं।

पैरामीटर:

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

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 (स्ट्रिंग की ऐरे)

get-marketing-stats

दिनांक सीमा के लिए कैंपेन और ऑटोमेशन के कुल Email Marketing आँकड़े प्राप्त करें: भेजे गए, डिलीवरी, बाउंस, ओपन, क्लिक, स्पैम और सदस्यता समाप्ति की संख्याएँ और दरें। delivery_rate और bounce_rate, sent_count के हिस्से हैं; अन्य दरें delivery_count के हिस्से हैं।

पैरामीटर:

• start_date (आवश्यक): दिनांक सीमा की शुरुआत (समावेशी), YYYY-MM-DD
• end_date (आवश्यक): दिनांक सीमा का अंत (समावेशी), YYYY-MM-DD
• sending_domain_ids (वैकल्पिक): परिणामों को इन डोमेन ID तक सीमित करें (पूर्णांकों की ऐरे)
• sources (वैकल्पिक): campaigns या automations आँकड़ों को उस स्रोत तक सीमित करता है; सभी Email Marketing ट्रैफ़िक के लिए इसे छोड़ दें या दोनों पास करें (स्ट्रिंग की ऐरे)
• email_service_providers (वैकल्पिक): परिणामों को इन प्रदाताओं तक सीमित करें, जैसे Google, Yahoo, Outlook (स्ट्रिंग की ऐरे)

create-template

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

पैरामीटर:

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

list-templates

पेज-टोकन पृष्ठांकन के साथ आपके Mailtrap खाते के ईमेल टेम्पलेट की सूची देता है। अधिक टेम्पलेट होने पर, परिणाम अगले पृष्ठ के लिए token बताता है। पृष्ठ, सबसे नए टेम्पलेट से शुरू होने वाली सूची के ऑफ़सेट हैं; इसलिए टेम्पलेट हटाने के बाद, अगले टोकन से जारी रखने के बजाय token 1 से फिर सूची बनाएँ। खाली पृष्ठ में उस अंतिम पृष्ठ का नाम दिया जाता है जिसमें अभी भी टेम्पलेट हैं।

पैरामीटर:

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

get-template

ID के आधार पर एक ईमेल टेम्पलेट प्राप्त करें, जिसमें विषय, श्रेणी और HTML/टेक्स्ट मुख्य भाग शामिल हैं।

पैरामीटर:

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

update-template

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

पैरामीटर:

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

[!NOTE] अपडेट करने के लिए update-template कॉल करते समय, अपडेट किए जा सकने वाले कम-से-कम एक फ़ील्ड (name, subject, html, text या category) को प्रदान करना आवश्यक है।

delete-template

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

पैरामीटर:

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

send-sandbox-email

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

पैरामीटर:

• sandbox_id (वैकल्पिक): प्राथमिकता वाला। Mailtrap sandbox ID। आवश्यक है, जब तक MAILTRAP_SANDBOX_ID सेट न हो।
• test_inbox_id (वैकल्पिक): जब sandbox_id छोड़ा गया हो, तब sandbox_id का पुराना उपनाम।
• from (वैकल्पिक): { email, name? } के रूप में प्रेषक (रनटाइम पर सादा ईमेल स्ट्रिंग भी स्वीकार की जाती है)। यदि प्रदान न किया जाए, तो DEFAULT_FROM_EMAIL का उपयोग किया जाता है।
• to (वैकल्पिक): { email, name? } ऑब्जेक्ट के रूप में प्राप्तकर्ताओं की ऐरे (ऐरे में सादे ईमेल स्ट्रिंग या सादे ईमेल की अल्पविराम से अलग की गई स्ट्रिंग भी रनटाइम पर स्वीकार की जाती है)। यदि cc या bcc प्रदान किया गया हो, तो यह वैकल्पिक है; to / cc / bcc में से कम-से-कम एक में प्राप्तकर्ता होना चाहिए।
• cc (वैकल्पिक): { email, name? } ऑब्जेक्ट के रूप में CC प्राप्तकर्ताओं की ऐरे (सादी ईमेल स्ट्रिंग भी रनटाइम पर स्वीकार की जाती हैं)।
• bcc (वैकल्पिक): { email, name? } ऑब्जेक्ट के रूप में BCC प्राप्तकर्ताओं की ऐरे (सादी ईमेल स्ट्रिंग भी रनटाइम पर स्वीकार की जाती हैं)।
• 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 sandbox पर ईमेल का बैच भेजता है, बिना वास्तविक प्राप्तकर्ताओं को डिलीवर किए। इसमें batch-send-transactional-email जैसे ही base + requests[] का आकार, सत्यापन और इनलाइन-बनाम-टेम्पलेट नियम लागू होते हैं — अंतर यह है कि यह टूल कॉल को एक sandbox के लिए sandbox endpoint के माध्यम से रूट करता है।

पैरामीटर:

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

[!NOTE] अधिकांश sandbox टूल sandbox_id लेते हैं (या इसके न होने पर MAILTRAP_SANDBOX_ID का उपयोग करते हैं; अप्रचलित env MAILTRAP_TEST_INBOX_ID अब भी काम करता है)। send-sandbox-email, get-sandbox-messages, और show-sandbox-email-message पुराने test_inbox_id को भी स्वीकार करते हैं। get-sandbox, update-sandbox, delete-sandbox, और clean-sandbox पुराने inbox_id के साथ sandbox_id का उपयोग करते हैं (एक ही ID; संदेश टूल में inbox_id का उपयोग नहीं होता)। इनबाउंड ईमेल टूल एक अलग उत्पाद (प्राप्त मेल) के लिए inbox_id का उपयोग करते हैं, sandbox के लिए नहीं।

get-sandbox-messages

आपके Mailtrap sandbox से संदेशों की सूची प्राप्त करता है। परीक्षण के दौरान आपके sandbox में प्राप्त ईमेल देखने के लिए उपयोगी है।

पैरामीटर:

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

[!NOTE] MAILTRAP_SANDBOX_ID सेट होने पर Sandbox ID पैरामीटर वैकल्पिक हैं। यदि sandbox_id, test_inbox_id, या env में से कुछ भी प्रदान नहीं किया गया, तो कॉल विफल हो जाती है। पृष्ठांकन: आवश्यकतानुसार page, last_id, या search का उपयोग करें।

show-sandbox-email-message

आपके Mailtrap sandbox से किसी विशिष्ट ईमेल संदेश की विस्तृत जानकारी और सामग्री दिखाता है, जिसमें HTML और टेक्स्ट मुख्य भाग की सामग्री शामिल है।

पैरामीटर:

• sandbox_id (वैकल्पिक): प्राथमिकता वाला। जब तक MAILTRAP_SANDBOX_ID सेट न हो, Sandbox ID।
• test_inbox_id (वैकल्पिक): sandbox_id का पुराना उपनाम।
• message_id (आवश्यक): प्राप्त किए जाने वाले sandbox ईमेल संदेश की ID

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

list-sandbox-projects

सभी sandbox प्रोजेक्ट और उनके sandbox की सूची बनाता है।

पैरामीटर:

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

create-sandbox-project

Sandbox को समूहित करने के लिए नया sandbox प्रोजेक्ट बनाएँ।

पैरामीटर:

• name (आवश्यक): प्रोजेक्ट का नाम (2–100 वर्ण)

get-sandbox-project

किसी प्रोजेक्ट की ID से उसे प्राप्त करें, जिसमें उसके sandbox और ईमेल की संख्या शामिल है।

पैरामीटर:

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

update-sandbox-project

मौजूदा sandbox प्रोजेक्ट का नाम बदलें।

पैरामीटर:

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

delete-sandbox-project

Sandbox प्रोजेक्ट और उसके सभी sandbox हटाएँ।

पैरामीटर:

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

create-sandbox

किसी प्रोजेक्ट के भीतर नया sandbox बनाएँ। नए sandbox के SMTP क्रेडेंशियल लौटाता है।

पैरामीटर:

• project_id (आवश्यक): वह प्रोजेक्ट ID जिसमें sandbox बनाना है
• name (आवश्यक): sandbox का नाम

get-sandbox

SMTP क्रेडेंशियल, ईमेल की संख्या और स्थिति सहित sandbox का विवरण प्राप्त करें।

पैरामीटर:

• sandbox_id (वैकल्पिक): Sandbox ID। आवश्यक है, जब तक MAILTRAP_SANDBOX_ID सेट न हो।
• inbox_id (वैकल्पिक): sandbox_id का पुराना उपनाम।

update-sandbox

Sandbox का नाम या ईमेल उपयोगकर्ता नाम अपडेट करें।

पैरामीटर:

• sandbox_id (आवश्यक): Sandbox ID (पुराना उपनाम: inbox_id)
• name (वैकल्पिक): sandbox का नया नाम
• email_username (वैकल्पिक): sandbox का नया ईमेल उपयोगकर्ता नाम

name या email_username में से कम-से-कम एक प्रदान करना आवश्यक है।

delete-sandbox

Sandbox और उसके सभी संदेश हटाएँ।

पैरामीटर:

• sandbox_id (आवश्यक): Sandbox ID (पुराना उपनाम: inbox_id)

clean-sandbox

Sandbox को हटाए बिना उसके सभी संदेश हटाएँ।

पैरामीटर:

• sandbox_id (आवश्यक): Sandbox ID (पुराना उपनाम: inbox_id)

list-sandboxes

सभी प्रोजेक्ट में API टोकन के लिए उपलब्ध हर sandbox की सूची बनाता है।

पैरामीटर:

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

mark-sandbox-as-read

Sandbox के सभी संदेशों को पढ़ा हुआ चिह्नित करें।

पैरामीटर:

• sandbox_id (आवश्यक): जिस sandbox पर कार्रवाई करनी है उसकी ID

reset-sandbox-credentials

Sandbox के SMTP क्रेडेंशियल रीसेट करें। नया उपयोगकर्ता नाम/पासवर्ड लौटाता है।

पैरामीटर:

• sandbox_id (आवश्यक): जिस sandbox पर कार्रवाई करनी है उसकी ID

enable-sandbox-email-address

Sandbox के लिए ईमेल द्वारा प्राप्त करने वाला पता सक्षम करें (इससे Mailtrap पता चालू होता है, जो SMTP के माध्यम से संदेशों को sandbox तक पहुँचाता है)।

पैरामीटर:

• sandbox_id (आवश्यक): जिस sandbox पर कार्रवाई करनी है उसकी ID

reset-sandbox-email-address

Sandbox के लिए नया ईमेल द्वारा प्राप्त करने वाला पता बनाएँ।

पैरामीटर:

• sandbox_id (आवश्यक): जिस sandbox पर कार्रवाई करनी है उसकी ID

forward-sandbox-message

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

पैरामीटर:

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

update-sandbox-message

Sandbox संदेश को पढ़ा हुआ या अपठित चिह्नित करें।

पैरामीटर:

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

delete-sandbox-message

एक sandbox संदेश हटाएँ।

पैरामीटर:

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

get-sandbox-message-spam-score

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

पैरामीटर:

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

get-sandbox-message-html-analysis

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

पैरामीटर:

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

get-sandbox-message-headers

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

पैरामीटर:

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

get-sandbox-message-html

Sandbox संदेश का रेंडर किया गया HTML मुख्य भाग प्राप्त करें।

पैरामीटर:

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

get-sandbox-message-text

Sandbox संदेश का सादा टेक्स्ट मुख्य भाग प्राप्त करें।

पैरामीटर:

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

get-sandbox-message-raw

Sandbox संदेश को कच्चे MIME-स्वरूप में (हेडर + मुख्य भाग) प्राप्त करें।

पैरामीटर:

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

get-sandbox-message-eml

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

पैरामीटर:

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

get-sandbox-message-html-source

Sandbox संदेश का बिना रेंडर किया गया HTML स्रोत प्राप्त करें (Mailtrap की ओर से किए गए रूपांतरणों, जैसे CID-लिंक पुनर्लेखन, से पहले का HTML)।

पैरामीटर:

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

list-sandbox-attachments

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

पैरामीटर:

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

get-sandbox-attachment

किसी एक अटैचमेंट का मेटाडेटा और डाउनलोड URL प्राप्त करें।

पैरामीटर:

• sandbox_id (वैकल्पिक): Sandbox ID। MAILTRAP_SANDBOX_ID पर वापस जाता है।
• message_id (आवश्यक): उस sandbox संदेश की ID जिसमें अटैचमेंट है
• attachment_id (आवश्यक): प्राप्त किए जाने वाले अटैचमेंट की ID

list-domains

डोमेन और उनकी DNS सत्यापन स्थिति की सूची बनाएँ।

पैरामीटर:

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

get-domain

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

पैरामीटर:

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

create-domain

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

पैरामीटर:

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

update-domain

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

पैरामीटर:

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

domain_id के अलावा कम-से-कम एक सेटिंग देना आवश्यक है।

delete-domain

डोमेन हटाएँ।

पैरामीटर:

• domain_id (आवश्यक): हटाने के लिए डोमेन ID (पुराना उपनाम: sending_domain_id)

send-domain-setup-instructions

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

पैरामीटर:

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

get-company-info

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

पैरामीटर:

• domain_id (आवश्यक): डोमेन ID (पुराना उपनाम: sending_domain_id)

create-company-info

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

पैरामीटर:

• domain_id (आवश्यक): डोमेन ID (पुराना उपनाम: sending_domain_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

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

पैरामीटर:

• domain_id (आवश्यक): डोमेन ID (पुराना उपनाम: sending_domain_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 (वैकल्पिक, boolean): डिफ़ॉल्ट रूप से 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 (वैकल्पिक, boolean): वेबहुक सक्षम या अक्षम करें
• 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 (वैकल्पिक, boolean): संपर्क को 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 (वैकल्पिक, boolean): unsubscribed (true) या subscribed (false) पर सेट करें

delete-contact

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

पैरामीटर:

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

create-contact-event

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

पैरामीटर:

• contact_identifier (आवश्यक): संपर्क ID या ईमेल
• name (आवश्यक): इवेंट का नाम (ऑटोमेशन ट्रिगर से मेल खाता है)
• params (आवश्यक): मनमाने कुंजी/मान युग्मों का ऑब्जेक्ट। मान स्ट्रिंग, संख्या, बूलियन या 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 (आवश्यक): डिस्प्ले नाम (उदा. "First 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

संपर्क इंपोर्ट जॉब की स्थिति (created/started/finished/failed) और बनाए गए/अपडेट किए गए/सीमा से अधिक संपर्कों की संख्या प्राप्त करें।

पैरामीटर:

• import_id (आवश्यक): संपर्क इंपोर्ट जॉब का ID

create-contact-export

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

पैरामीटर:

• 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, जैसा कि list-domains से प्राप्त हुआ है
• from_local_part (आवश्यक): From पते का स्थानीय भाग (@ से पहले)
• template_attributes (आवश्यक): इनलाइन ईमेल टेम्पलेट। इसमें शामिल हैं:
  • subject (आवश्यक): ईमेल की विषय पंक्ति (अधिकतम 255 वर्ण)। मर्ज टैग समर्थित हैं, जैसे Hi {{first_name}}
  • body_html (वैकल्पिक): HTML बॉडी (डिज़ाइन)। कैंपेन को शेड्यूल या शुरू करने से पहले यह आवश्यक है। ऐसे एंकर के ज़रिए सदस्यता रद्द करने का लिंक शामिल करें, जिसके href में __unsubscribe_url__ प्लेसहोल्डर हो
  • body_text (वैकल्पिक): ईमेल बॉडी का सादा-पाठ विकल्प
  • merge_tags (वैकल्पिक): विषय/बॉडी में संदर्भित मर्ज टैग के केवल नाम, जैसे ["first_name"]
• from_display_name (वैकल्पिक): From हेडर में दिखाया जाने वाला डिस्प्ले नाम
• reply_to (वैकल्पिक): 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 टोकन एक्सेस कर सकता है, साथ में प्रत्येक खाते के एक्सेस स्तर भी। यह MAILTRAP_ACCOUNT_ID के बिना काम करता है, इसलिए इसका उपयोग अपनी खाता ID खोजने के लिए करें।

पैरामीटर:

• किसी पैरामीटर की आवश्यकता नहीं

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 (आवश्यक): लक्षित खाता एक्सेस ID
• permissions (आवश्यक): अनुमति प्रविष्टियों की ऐरे। प्रत्येक में ये शामिल हैं:
  • resource_id (आवश्यक): संसाधन ID (संख्या या स्ट्रिंग)
  • resource_type (आवश्यक): इनमें से एक: account, project, inbox, domain, billing
  • access_level (वैकल्पिक): admin/100 या viewer/10
  • destroy (वैकल्पिक, बूलियन): true होने पर, यह अनुमति बनाने/अपडेट करने के बजाय हटाता है

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 (आवश्यक): संसाधन की ID
  • access_level (आवश्यक): 100 (एडमिन) या 10 (व्यूअर)

get-api-token

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

पैरामीटर:

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

reset-api-token

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

पैरामीटर:

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

delete-api-token

ID के आधार पर API टोकन को स्थायी रूप से हटाएँ। हटाए जाने के बाद टोकन से प्रमाणीकरण नहीं किया जा सकता।

पैरामीटर:

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

list-sub-accounts

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

पैरामीटर:

• किसी पैरामीटर की आवश्यकता नहीं

create-sub-account

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

पैरामीटर:

• name (आवश्यक): नए सब-अकाउंट का डिस्प्ले नाम

delete-sub-account

ID के आधार पर सब-अकाउंट को स्थायी रूप से हटाएँ और उसका सारा डेटा मिटाएँ। आखिरी सब-अकाउंट हटाने से संगठन हट जाता है; दोबारा की गई कॉल 404 लौटाती है। उसी सब-अकाउंट को एक साथ हटाने की कोशिश 409 लौटाती है। इसके लिए MAILTRAP_ORGANIZATION_ID env var और संगठन एडमिन की अनुमतियाँ आवश्यक हैं, और संगठन में Organization & Sub-accounts सुविधा सक्षम होनी चाहिए (अन्यथा 403)।

पैरामीटर:

• sub_account_id (आवश्यक): हटाए जाने वाले सब-अकाउंट की ID

list-inbound-folders

खाते के सभी इनबाउंड फ़ोल्डर की सूची बनाएँ। फ़ॉर्मैट किया हुआ सारांश लौटाता है।

पैरामीटर:

• किसी पैरामीटर की आवश्यकता नहीं

get-inbound-folder

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

पैरामीटर:

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

create-inbound-folder

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

पैरामीटर:

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

update-inbound-folder

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

पैरामीटर:

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

delete-inbound-folder

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

पैरामीटर:

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

list-inbound-inboxes

इनबाउंड फ़ोल्डर के सभी इनबॉक्स की सूची बनाएँ। फ़ॉर्मैट किया हुआ सारांश लौटाता है।

पैरामीटर:

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

get-inbound-inbox

ID के आधार पर एक इनबाउंड इनबॉक्स प्राप्त करें। पूरा इनबॉक्स रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

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

create-inbound-inbox

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

पैरामीटर:

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

update-inbound-inbox

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

पैरामीटर:

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

delete-inbound-inbox

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

पैरामीटर:

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

list-inbound-messages

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

पैरामीटर:

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

get-inbound-message

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

पैरामीटर:

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

delete-inbound-message

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

पैरामीटर:

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

reply-to-inbound-message

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

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID
• message_id (आवश्यक): जवाब दिए जाने वाले संदेश का 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 (आवश्यक): इनबॉक्स का ID
• message_id (आवश्यक): जवाब दिए जाने वाले संदेश का ID
• साथ ही reply-to-inbound-message जैसे ही वैकल्पिक भेजने वाले फ़ील्ड

forward-inbound-message

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

पैरामीटर:

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

list-inbound-threads

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

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID
• last_id (वैकल्पिक): पिछले जवाब के last_id से पृष्ठांकन कर्सर
• search (वैकल्पिक): थ्रेड के विषय और उसके संदेशों के from/to/cc/bcc पतों से मिलान किया गया, केस-संवेदी न होने वाला टेक्स्ट। पृष्ठांकन करते समय यही मान पास करें

get-inbound-thread

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

पैरामीटर:

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

delete-inbound-thread

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

पैरामीटर:

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

list-inbound-forward-rules

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

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID

get-inbound-forward-rule

ID के आधार पर कोई एक इनबाउंड फ़ॉरवर्ड नियम प्राप्त करें। शर्तों और गंतव्यों सहित पूरा नियम रिकॉर्ड JSON के रूप में लौटाता है।

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID
• forward_rule_id (आवश्यक): फ़ॉरवर्ड नियम का ID

create-inbound-forward-rule

इनबाउंड इनबॉक्स पर फ़ॉरवर्ड नियम बनाएँ। सभी शर्तों से मेल खाने वाले प्राप्त संदेश नियम के गंतव्यों पर फ़ॉरवर्ड किए जाते हैं।

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID
• name (आवश्यक): नियम का नाम, इनबॉक्स में अद्वितीय
• conditions (वैकल्पिक): { match_type, operator, value?, header_key? } की ऐरे। match_type का मान sender, recipient, या header होता है; operator का मान equal, not_equal, contains, starts_with, ends_with, empty, या not_empty होता है (empty/not_empty केवल header के लिए हैं और इनमें कोई value नहीं होता); header के लिए header_key आवश्यक है। सभी संदेशों से मेल खाने के लिए इसे छोड़ दें या [] पास करें
• destinations (वैकल्पिक): मेल खाने वाले संदेशों को फ़ॉरवर्ड करने के लिए { email } की ऐरे

update-inbound-forward-rule

इनबाउंड फ़ॉरवर्ड नियम अपडेट करें। केवल दिए गए फ़ील्ड बदलते हैं; दिया गया conditions या destinations ऐरे पूरे सेट को बदल देता है।

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID
• forward_rule_id (आवश्यक): फ़ॉरवर्ड नियम का ID
• name (वैकल्पिक): नया नियम नाम
• conditions (वैकल्पिक): बदली हुई शर्तों का सेट (बनाते समय वाले ही आकार में); [] सभी शर्तें हटा देता है, जिससे नियम हर संदेश से मेल खाता है
• destinations (वैकल्पिक): बदले हुए गंतव्यों का सेट; [] सभी गंतव्य हटा देता है

delete-inbound-forward-rule

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

पैरामीटर:

• inbox_id (आवश्यक): इनबॉक्स का ID
• forward_rule_id (आवश्यक): फ़ॉरवर्ड नियम का ID

विकास

1. रिपॉज़िटरी क्लोन करें:

git clone https://github.com/mailtrap/mailtrap-mcp.git
cd mailtrap-mcp

2. निर्भरताएँ इंस्टॉल करें:

npm install

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

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

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

{
  "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_SANDBOX_ID": "your_sandbox_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": "22.14.0",
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
      }
    }
  }
}

VS Code

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

{
  "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_SANDBOX_ID": "your_sandbox_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-domain-setup-instructions \
  --tool-arg domain_id=3938 \
  --tool-arg email=devops@example.com

MCPB Server चलाना

# 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 सेकंड)
• त्रुटि आउटपुट में संवेदनशील विवरणों को साफ़ किया जाता है

लॉगिंग

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

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 Token अनुपलब्ध: सुनिश्चित करें कि MAILTRAP_API_TOKEN सेट है
2. Sandbox काम नहीं कर रहा: टूल कॉल में sandbox_id दें (या संदेश भेजने/सूचीबद्ध करने/दिखाने वाले टूल पर पुराना test_inbox_id), या MAILTRAP_SANDBOX_ID env सेट करें
3. टाइमआउट त्रुटियाँ: नेटवर्क कनेक्टिविटी और Mailtrap API की स्थिति जाँचें
4. सत्यापन त्रुटियाँ: सुनिश्चित करें कि सभी आवश्यक फ़ील्ड दिए गए हैं

योगदान

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

लाइसेंस

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

आचार संहिता

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