Mailtrap

आधिकारिक

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

GitHub

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

ट्रांज़ैक्शनल ईमेल भेजें — send-email के माध्यम से इनलाइन सामग्री या टेम्पलेट के साथ ईमेल भेजने का अनुरोध करें, जिसमें CC/BCC और कस्टम वेरिएबल शामिल हों।
ईमेल टेम्पलेट प्रबंधित करें — पुन: उपयोग योग्य ईमेल डिज़ाइन बनाए रखने के लिए list-templates, create-template, update-template, या delete-template का उपयोग करें।
डिलीवरी लॉग निरीक्षण करें — प्राप्तकर्ता, स्थिति, या तिथि जैसे फ़िल्टर के साथ list-email-logs क्वेरी करें, फिर get-email-log-message के साथ विवरण में जाएँ।
सैंडबॉक्स में ईमेल परीक्षण करें — send-sandbox-email के माध्यम से परीक्षण इनबॉक्स में भेजें, फिर get-sandbox-messages और show-sandbox-email-message के साथ संदेशों की समीक्षा करें।
भेजने के प्रदर्शन का विश्लेषण करें — get-sending-stats के माध्यम से डिलीवरी, बाउंस और सहभागिता दरें प्राप्त करें, वैकल्पिक रूप से डोमेन या श्रेणी के अनुसार विभाजित।
भेजने का बुनियादी ढांचा कॉन्फ़िगर करें — list-sending-domains प्रबंधित करें, डोमेन बनाएं या हटाएं, और DNS सेटअप निर्देश प्राप्त करें।

दस्तावेज़

MCP Mailtrap सर्वर

एक MCP सर्वर जो Mailtrap के माध्यम से सैंडबॉक्स में ईमेल भेजने और परीक्षण के लिए टूल प्रदान करता है।

आवश्यक शर्तें

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

Mailtrap खाता बनाएं
अपना डोमेन सत्यापित करें
अपना API टोकन Mailtrap API सेटिंग्स से प्राप्त करें
अपना खाता आईडी Mailtrap खाता प्रबंधन से प्राप्त करें

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

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

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

DEFAULT_FROM_EMAIL - डिफ़ॉल्ट प्रेषक ईमेल जब send-email, send-sandbox-email, या batch-send-* टूल को from प्रदान नहीं किया जाता है (जहां यह base.from भरता है)। from पैरामीटर के माध्यम से प्रति कॉल प्रेषक को स्विच करने में सक्षम बनाता है।
MAILTRAP_SANDBOX_ID - डिफ़ॉल्ट सैंडबॉक्स आईडी सैंडबॉक्स टूल के लिए जब sandbox_id प्रदान नहीं किया जाता है। sandbox_id पैरामीटर के माध्यम से प्रति कॉल सैंडबॉक्स के बीच स्विच करने में सक्षम बनाता है।
MAILTRAP_TEST_INBOX_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 से अलग)।

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

Smithery CLI

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

npx @smithery/cli install mailtrap

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

सेटअप

Claude डेस्कटॉप

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

Claude डेस्कटॉप या 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 डेस्कटॉप कॉन्फ़िग फ़ाइल स्थान

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 हटाएं"
"DNS सेटअप निर्देशों के साथ भेजने वाला डोमेन 3938 प्राप्त करें"

उपलब्ध टूल

send-email

Mailtrap के माध्यम से एक ट्रांज़ैक्शनल ईमेल भेजता है। दो परस्पर अनन्य मोड का समर्थन करता है — इनलाइन सामग्री (subject + text/html) या टेम्पलेट-आधारित (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 ईमेल टेम्पलेट का उपयोग करें। सेट होने पर, 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 के माध्यम से बल्क ईमेल का एक बैच भेजता है। 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 (वैकल्पिक): भेजने वाले डोमेन आईडी (संख्या) द्वारा फ़िल्टर करें; 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) द्वारा एक एकल ईमेल लॉग संदेश प्राप्त करता है: एक पठनीय सारांश (from, to, subject, sent time, status, category, stream, engagement, delivery context), फिर विस्तृत घटना इतिहास। वैकल्पिक रूप से, include_content: true के साथ, आप संदेश बॉडी (HTML और सादा टेक्स्ट) भी लोड और दिखा सकते हैं जब Mailtrap एक कच्चा संदेश URL उजागर करता है।

पैरामीटर:

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

get-sending-stats

किसी तिथि सीमा के लिए ईमेल भेजने के आँकड़े (delivery, bounce, open, click, spam दरें) प्राप्त करें। वैकल्पिक रूप से domain, category, email service provider, या date द्वारा विभाजित करें। संपादक से बाहर निकले बिना delivery दर जाँचें।

पैरामीटर:

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 (वैकल्पिक): परिणामों को इन sending domain IDs तक सीमित करें (पूर्णांकों की सरणी)
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

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

पैरामीटर:

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

update-template

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

पैरामीटर:

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

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

delete-template

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

पैरामीटर:

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

send-sandbox-email

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

पैरामीटर:

test_inbox_id (वैकल्पिक): Mailtrap परीक्षण इनबॉक्स आईडी। जब तक MAILTRAP_TEST_INBOX_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 परीक्षण इनबॉक्स में ईमेल का बैच भेजता है, बिना वास्तविक प्राप्तकर्ताओं को वितरित किए। base + requests[] आकार, सत्यापन, और इनलाइन-वर्सेस-टेम्पलेट नियम batch-send-transactional-email के समान — अंतर यह है कि यह टूल कॉल को एक ही परीक्षण इनबॉक्स के लिए sandbox एंडपॉइंट के माध्यम से रूट करता है।

पैरामीटर:

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

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

get-sandbox-messages

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

पैरामीटर:

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

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

show-sandbox-email-message

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

पैरामीटर:

message_id (आवश्यक): प्राप्त करने के लिए sandbox ईमेल संदेश की आईडी

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

get-sandbox-project

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

पैरामीटर:

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

update-sandbox-project

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

पैरामीटर:

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

list-sandboxes

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

पैरामीटर:

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

mark-sandbox-as-read

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

पैरामीटर:

sandbox_id (आवश्यक): कार्य करने के लिए sandbox की आईडी

reset-sandbox-credentials

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

पैरामीटर:

sandbox_id (आवश्यक): कार्य करने के लिए sandbox की आईडी

enable-sandbox-email-address

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

पैरामीटर:

sandbox_id (आवश्यक): कार्य करने के लिए sandbox की आईडी

reset-sandbox-email-address

किसी sandbox के लिए नया ईमेल-द्वारा-प्राप्त करने वाला पता生成 करें।

पैरामीटर:

sandbox_id (आवश्यक): कार्य करने के लिए sandbox की आईडी

forward-sandbox-message

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

पैरामीटर:

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

update-sandbox-message

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

पैरामीटर:

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

delete-sandbox-message

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

पैरामीटर:

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

get-sandbox-message-spam-score

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

पैरामीटर:

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

get-sandbox-message-html-analysis

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

पैरामीटर:

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

get-sandbox-message-headers

किसी sandbox संदेश के लिए parsed mail हेडर प्राप्त करें।

पैरामीटर:

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

get-sandbox-message-html

किसी sandbox संदेश का rendered HTML बॉडी प्राप्त करें।

पैरामीटर:

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

get-sandbox-message-text

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

पैरामीटर:

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

get-sandbox-message-raw

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

पैरामीटर:

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

get-sandbox-message-eml

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

पैरामीटर:

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

get-sandbox-message-html-source

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

पैरामीटर:

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

list-sandbox-attachments

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

पैरामीटर:

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

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)

delete-sending-domain

एक सेंडिंग डोमेन हटाएँ।

पैरामीटर:

sending_domain_id (आवश्यक): हटाने के लिए सेंडिंग डोमेन ID

send-sending-domain-setup-instructions

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

पैरामीटर:

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

list-suppressions

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

पैरामीटर:

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

delete-suppression

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

पैरामीटर:

suppression_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 (आवश्यक): मनमाने कुंजी/मान जोड़े की वस्तु। मान स्ट्रिंग, संख्या, बूलियन, या 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-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 (आवश्यक): टोकन के लिए प्रदर्शन नाम
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 टोकन की आईडी

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 (आवश्यक): थ्रेड की आईडी

विकास

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

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

निर्भरताएँ स्थापित करें:

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_TEST_INBOX_ID": "your_test_inbox_id"
      }
    }
  }
}

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

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

{
  "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] कॉन्फ़िग फ़ाइल का स्थान सेटअप अनुभाग में देखें।

{
  "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 एक URL जैसे http://localhost:6274 प्रिंट करता है। इसे खोलें, 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")'

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

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

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

योगदान

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

लाइसेंस

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

आचार संहिता

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