inxmail-mcp

npm version npm downloads License: MIT MCP Node.js Glama Awesome MCP Servers

MCP-Server für die Inxmail Commerce Transactional API. Verwalten Sie Events, Sendungen, Bounces, Blocklisten, Blacklisten, Reaktionen und Zustellungs-Tracking — direkt aus Claude heraus.

Schnelleinstieg

1. Installation

npm install -g inxmail-mcp
# or use npx (no install needed)

2. API-Zugangsdaten abrufen

Erstellen Sie in Ihrem Inxmail Commerce Admin-Panel einen API-Schlüssel unter API-Zugangsdaten. Sie erhalten:

API Key ID (Benutzername)
API Secret (Passwort)

Ihr Instanzname ist die Subdomain aus Ihrer Inxmail Commerce API-URL:

https://your-instance.api.inxmail-commerce.com/ -> Instanz = your-instance

3. Konfiguration für 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

Oder aus dem Quellcode:

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. Konfiguration für Claude Desktop

Fügen Sie dies zu claude_desktop_config.json hinzu:

{
  "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"
      }
    }
  }
}

Verfügbare Tools

Kern-Anwendungsfälle

Tool	Beschreibung
`check_email_delivery`	Überprüfen Sie den Zustellungsstatus einer E-Mail — Sendungen, Bounces, Reaktionen und Blockierstatus
`check_email_blocked`	Überprüfen Sie, ob eine E-Mail blockiert ist (Blockliste Hard-Bounces + Blackliste explizite Sperren)
`get_server_info`	API-Einstiegspunkt mit Links zu allen verfügbaren Ressourcen abrufen

Events

Tool	Beschreibung
`trigger_event`	Ein transaktionales E-Mail-Event auslösen
`get_event_state`	Status/Ergebnis eines ausgelösten Events anhand der Transaktions-ID abrufen
`list_event_types`	Alle konfigurierten Event-Typen auflisten
`get_event_type`	Einen einzelnen Event-Typ anhand der ID abrufen

Sendungen

Tool	Beschreibung
`list_sendings`	Gesendete Transaktions-E-Mails mit Filtern auflisten
`get_sending`	Details einer bestimmten Sendung anhand der ID abrufen

Reaktionen & Tracking

Tool	Beschreibung
`list_reactions`	Empfänger-Reaktionen (Öffnungen und Klicks) auflisten
`list_deliveries`	Informationen zum Zustellungsstatus auflisten

Bounces & Beschwerden

Tool	Beschreibung
`list_bounces`	Bounced Transaktions-E-Mails auflisten
`list_complaints`	Feedback-Loop-Beschwerden auflisten

Blockliste (Hard-Bounces)

Tool	Beschreibung
`list_blocklist`	E-Mail-Adressen auflisten, die aufgrund von Hard-Bounces blockiert sind
`get_blocklist_entry`	Überprüfen, ob eine bestimmte E-Mail auf der Blockliste steht
`remove_from_blocklist`	Eine E-Mail von der Blockliste entfernen

Blackliste (Explizite Sperren)

Tool	Beschreibung
`list_blacklist`	Explizit auf der Blackliste stehende E-Mail-Adressen auflisten
`get_blacklist_entry`	Überprüfen, ob eine bestimmte E-Mail auf der Blackliste steht
`add_to_blacklist`	Eine E-Mail-Adresse zur Blackliste hinzufügen
`remove_from_blacklist`	Eine E-Mail von der Blackliste entfernen

Mail-Relay

Tool	Beschreibung
`list_relay_sendings`	Mail-Relay-Sendungen auflisten
`get_relay_sending`	Details einer bestimmten Mail-Relay-Sendung abrufen
`list_relay_reactions`	Mail-Relay-Reaktionen (Öffnungen, Klicks) auflisten
`list_relay_bounces`	Mail-Relay-Bounces auflisten
`list_relay_complaints`	Mail-Relay-Beschwerden auflisten

Raw-Mail

Tool	Beschreibung
`send_raw_mail`	Eine vollständige RFC 5322 E-Mail senden (Base64-kodiert)

Fehlerprotokolle

Tool	Beschreibung
`list_error_logs`	Fehlerprotokolleinträge auflisten
`get_error_log`	Einen einzelnen Fehlerprotokolleintrag anhand der ID abrufen
`mark_error_log_read`	Einen Fehlerprotokolleintrag als gelesen markieren

Beispiel-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"

Entwicklung

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

Testen

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

Führt Unit-Tests mit Vitest aus, die Folgendes abdecken:

API-Client (Authentifizierung, Anfragemethoden, Abfrageparameter, Paginierung, Fehlerbehandlung)
Tool-Registrierung (alle 29 Tools registriert, keine Duplikate)

Umgebungsvariablen

Variable	Erforderlich	Beschreibung
`INXMAIL_INSTANCE`	Ja	Instanz-Subdomain (z. B. `your-instance`)
`INXMAIL_API_KEY_ID`	Ja	API Key ID
`INXMAIL_API_SECRET`	Ja	API Secret

Lizenz

MIT

Inxmail MCP