inxmail-mcp

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

Servidor MCP para la API transaccional de Inxmail Commerce. Gestione eventos, envíos, rebotes, listas de bloqueo, listas negras, reacciones y seguimiento de entregas, directamente desde Claude.

Inicio rápido

1. Instalación

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

2. Obtener credenciales de API

En su panel de administración de Inxmail Commerce, cree una clave de API en Datos de inicio de sesión de API. Obtendrá:

ID de clave de API (nombre de usuario)
Secreto de API (contraseña)

El nombre de su instancia es el subdominio de su URL de API de Inxmail Commerce:

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

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

O desde el código fuente:

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. Configurar para Claude Desktop

Añada a 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"
      }
    }
  }
}

Herramientas disponibles

Casos de uso principales

Herramienta	Descripción
`check_email_delivery`	Comprobar el estado de entrega de un correo electrónico: envíos, rebotes, reacciones y estado de bloqueo
`check_email_blocked`	Comprobar si un correo electrónico está bloqueado (rebotes duros en lista de bloqueo + bloqueos explícitos en lista negra)
`get_server_info`	Obtener el punto de entrada de la API con enlaces a todos los recursos disponibles

Eventos

Herramienta	Descripción
`trigger_event`	Disparar un evento de correo electrónico transaccional
`get_event_state`	Obtener el estado/resultado de un evento disparado por ID de transacción
`list_event_types`	Listar todos los tipos de eventos configurados
`get_event_type`	Obtener un tipo de evento único por ID

Envíos

Herramienta	Descripción
`list_sendings`	Listar correos electrónicos de transacción enviados con filtros
`get_sending`	Obtener detalles de un envío específico por ID

Reacciones y seguimiento

Herramienta	Descripción
`list_reactions`	Listar reacciones de los destinatarios (aperturas y clics)
`list_deliveries`	Listar información sobre el estado de entrega

Rebotes y quejas

Herramienta	Descripción
`list_bounces`	Listar correos electrónicos de transacción rebotados
`list_complaints`	Listar quejas del bucle de retroalimentación

Lista de bloqueo (rebotes duros)

Herramienta	Descripción
`list_blocklist`	Listar direcciones de correo electrónico bloqueadas por rebote duro
`get_blocklist_entry`	Comprobar si un correo electrónico específico está en la lista de bloqueo
`remove_from_blocklist`	Eliminar un correo electrónico de la lista de bloqueo

Lista negra (bloqueos explícitos)

Herramienta	Descripción
`list_blacklist`	Listar direcciones de correo electrónico explícitamente en la lista negra
`get_blacklist_entry`	Comprobar si un correo electrónico específico está en la lista negra
`add_to_blacklist`	Añadir una dirección de correo electrónico a la lista negra
`remove_from_blacklist`	Eliminar un correo electrónico de la lista negra

Retransmisión de correo (Mail Relay)

Herramienta	Descripción
`list_relay_sendings`	Listar envíos de retransmisión de correo
`get_relay_sending`	Obtener detalles de un envío de retransmisión de correo específico
`list_relay_reactions`	Listar reacciones de retransmisión de correo (aperturas, clics)
`list_relay_bounces`	Listar rebotes de retransmisión de correo
`list_relay_complaints`	Listar quejas de retransmisión de correo

Correo sin procesar

Herramienta	Descripción
`send_raw_mail`	Enviar un correo electrónico RFC 5322 completo (codificado en Base64)

Registros de errores

Herramienta	Descripción
`list_error_logs`	Listar entradas de registro de errores
`get_error_log`	Obtener una entrada de registro de errores única por ID
`mark_error_log_read`	Marcar una entrada de registro de errores como leída

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

Desarrollo

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

Pruebas

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

Ejecuta pruebas unitarias con Vitest cubriendo:

Cliente de API (autenticación, métodos de solicitud, parámetros de consulta, paginación, manejo de errores)
Registro de herramientas (las 29 herramientas registradas, sin duplicados)

Variables de entorno

Variable	Requerido	Descripción
`INXMAIL_INSTANCE`	Sí	Subdominio de la instancia (p. ej., `your-instance`)
`INXMAIL_API_KEY_ID`	Sí	ID de clave de API
`INXMAIL_API_SECRET`	Sí	Secreto de API

Licencia

MIT

Inxmail MCP