inxmail-mcp

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

Inxmail Commerce Transactional API 用のMCPサーバーです。イベント、送信、バウンス、ブロックリスト、ブラックリスト、リアクション、および配信追跡をClaudeから直接管理できます。

クイックスタート

1. インストール

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

2. API認証情報の取得

Inxmail Commerce管理パネルの API Login Data でAPIキーを作成します。以下の情報が取得できます：

API Key ID (ユーザー名)
API Secret (パスワード)

インスタンス名は、Inxmail Commerce API URLのサブドメインです：

https://your-instance.api.inxmail-commerce.com/ -> インスタンス = your-instance

3. 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

またはソースから：

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. Claude Desktopの設定

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

利用可能なツール

基本的なユースケース

ツール	説明
`check_email_delivery`	メールの配信状況（送信、バウンス、リアクション、ブロック状態）を確認する
`check_email_blocked`	メールがブロックされているか確認する（ブロックリストのハードバウンス + ブラックリストの明示的ブロック）
`get_server_info`	利用可能なすべてのリソースへのリンクを含むAPIエントリーポイントを取得する

イベント

ツール	説明
`trigger_event`	トランザクションメールイベントをトリガーする
`get_event_state`	トランザクションIDでトリガーされたイベントの状態/結果を取得する
`list_event_types`	設定されているすべてのイベントタイプを一覧表示する
`get_event_type`	IDで特定のイベントタイプを取得する

送信

ツール	説明
`list_sendings`	フィルターを使用して送信済みトランザクションメールを一覧表示する
`get_sending`	IDで特定の送信の詳細を取得する

リアクションと追跡

ツール	説明
`list_reactions`	受信者のリアクション（開封およびクリック）を一覧表示する
`list_deliveries`	配信状況情報を一覧表示する

バウンスと苦情

ツール	説明
`list_bounces`	バウンスしたトランザクションメールを一覧表示する
`list_complaints`	フィードバックループの苦情を一覧表示する

ブロックリスト (ハードバウンス)

ツール	説明
`list_blocklist`	ハードバウンスによりブロックされたメールアドレスを一覧表示する
`get_blocklist_entry`	特定のメールがブロックリストにあるか確認する
`remove_from_blocklist`	ブロックリストからメールを削除する

ブラックリスト (明示的ブロック)

ツール	説明
`list_blacklist`	明示的にブラックリストに登録されたメールアドレスを一覧表示する
`get_blacklist_entry`	特定のメールがブラックリストにあるか確認する
`add_to_blacklist`	ブラックリストにメールアドレスを追加する
`remove_from_blacklist`	ブラックリストからメールを削除する

メールリレー

ツール	説明
`list_relay_sendings`	メールリレーの送信を一覧表示する
`get_relay_sending`	特定のメールリレー送信の詳細を取得する
`list_relay_reactions`	メールリレーのリアクション（開封、クリック）を一覧表示する
`list_relay_bounces`	メールリレーのバウンスを一覧表示する
`list_relay_complaints`	メールリレーの苦情を一覧表示する

生メール (Raw Mail)

ツール	説明
`send_raw_mail`	完全なRFC 5322メールを送信する（Base64エンコード）

エラーログ

ツール	説明
`list_error_logs`	エラーログエントリーを一覧表示する
`get_error_log`	IDで単一のエラーログエントリーを取得する
`mark_error_log_read`	エラーログエントリーを既読にする

プロンプト例

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

開発

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

テスト

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

Vitest を使用して以下のユニットテストを実行します：

APIクライアント（認証、リクエストメソッド、クエリパラメータ、ページネーション、エラーハンドリング）
ツール登録（全29ツールが登録され、重複がないこと）

環境変数

変数	必須	説明
`INXMAIL_INSTANCE`	はい	インスタンスのサブドメイン（例: `your-instance`）
`INXMAIL_API_KEY_ID`	はい	API Key ID
`INXMAIL_API_SECRET`	はい	API Secret

ライセンス

MIT

Inxmail MCP