English Français العربية

Inxmail MCP

مجتمعي الإنتاجية

Manage Inxmail Commerce transactional emails: events, sendings, bounces, blocklist and blacklist, reactions and delivery tracking.

الشيفرة المصدرية التوثيق

التثبيت

خطوات التثبيت موجودة في التوثيق أدناه. التوثيق

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. inxmail-mcp
  2. Quick Start
  3. Available Tools
  4. Example Prompts
  5. Development
  6. Testing
  7. Environment Variables
  8. License

inxmail-mcp

MCP server for the Inxmail Commerce Transactional API. Manage events, sendings, bounces, blocklist, blacklist, reactions, and delivery tracking — directly from Claude.

Quick Start

1. Install
npm install -g inxmail-mcp
# or use npx (no install needed)
2. Get API Credentials

In your Inxmail Commerce admin panel, create an API key under API Login Data. You'll get:

  • API Key ID (username)
  • API Secret (password)

Your instance name is the subdomain from your Inxmail Commerce API URL:

  • https://your-instance.api.inxmail-commerce.com/ -> instance = your-instance
3. Configure for Claude Code
claude mcp add inxmail-mcp -e INXMAIL_INSTANCE=your-instance -e INXMAIL_API_KEY_ID=your-key-id -e INXMAIL_API_SECRET=your-secret -- npx -y inxmail-mcp

Or from source:

claude mcp add inxmail-mcp -e INXMAIL_INSTANCE=your-instance -e INXMAIL_API_KEY_ID=your-key-id -e INXMAIL_API_SECRET=your-secret -- node /path/to/inxmail-mcp/build/index.js
4. Configure for Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "inxmail": {
      "command": "npx",
      "args": ["-y", "inxmail-mcp"],
      "env": {
        "INXMAIL_INSTANCE": "your-instance",
        "INXMAIL_API_KEY_ID": "your-key-id",
        "INXMAIL_API_SECRET": "your-secret"
      }
    }
  }
}

Available Tools

Core Use Cases
ToolDescription
check_email_deliveryCheck delivery status for an email — sendings, bounces, reactions, and block status
check_email_blockedCheck if an email is blocked (blocklist hard bounces + blacklist explicit blocks)
get_server_infoGet API entry point with links to all available resources
Events
ToolDescription
trigger_eventTrigger a transactional email event
get_event_stateGet the state/result of a triggered event by transaction ID
list_event_typesList all configured event types
get_event_typeGet a single event type by ID
Sendings
ToolDescription
list_sendingsList sent transaction emails with filters
get_sendingGet details of a specific sending by ID
Reactions & Tracking
ToolDescription
list_reactionsList recipient reactions (opens and clicks)
list_deliveriesList delivery status information
Bounces & Complaints
ToolDescription
list_bouncesList bounced transaction emails
list_complaintsList feedback loop complaints
Blocklist (Hard Bounces)
ToolDescription
list_blocklistList hard-bounce blocked email addresses
get_blocklist_entryCheck if a specific email is on the blocklist
remove_from_blocklistRemove an email from the blocklist
Blacklist (Explicit Blocks)
ToolDescription
list_blacklistList explicitly blacklisted email addresses
get_blacklist_entryCheck if a specific email is on the blacklist
add_to_blacklistAdd an email address to the blacklist
remove_from_blacklistRemove an email from the blacklist
Mail Relay
ToolDescription
list_relay_sendingsList mail relay sendings
get_relay_sendingGet details of a specific mail relay sending
list_relay_reactionsList mail relay reactions (opens, clicks)
list_relay_bouncesList mail relay bounces
list_relay_complaintsList mail relay complaints
Raw Mail
ToolDescription
send_raw_mailSend a complete RFC 5322 email (Base64-encoded)
Error Logs
ToolDescription
list_error_logsList error log entries
get_error_logGet a single error log entry by ID
mark_error_log_readMark an error log entry as read

Example Prompts

"Is test@example.com blocked or blacklisted?"

"Check the delivery status for user@example.com"

"List all bounces from last week"

"Trigger a welcome email event for new-user@example.com"

"Show me all event types configured in the system"

"List recent complaints from the last 30 days"

Development

git clone https://github.com/shahabazdev/inxmail-mcp.git
cd inxmail-mcp
npm install
npm run build

Testing

npm test          # run all tests
npx vitest        # run in watch mode

Runs unit tests with Vitest covering:

  • API client (auth, request methods, query params, pagination, error handling)
  • Tool registration (all 29 tools registered, no duplicates)

Environment Variables

VariableRequiredDescription
INXMAIL_INSTANCEYesInstance subdomain (e.g. your-instance)
INXMAIL_API_KEY_IDYesAPI Key ID
INXMAIL_API_SECRETYesAPI Secret

License

MIT

الأسئلة الشائعة

ما هو Inxmail MCP؟

Manage Inxmail Commerce transactional emails: events, sendings, bounces, blocklist and blacklist, reactions and delivery tracking.

كيف أثبّت Inxmail MCP؟

اتبع خطوات التثبيت في توثيقه المعروض في هذه الصفحة وفي مستودعه.

هل Inxmail MCP مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون Inxmail MCP؟

ينشره shahabazdev. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من القوائم المجتمعية awesome-mcp-servers ومستودع المشروع على GitHub. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.