inxmail-mcp

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

Inxmail Commerce Transactional API용 MCP 서버입니다. Claude에서 직접 이벤트, 발송, 바운스, 차단 목록(blocklist), 블랙리스트, 반응 및 배달 추적을 관리하세요.

빠른 시작

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`	메일 릴레이 불만 사항 나열

원본 메일

도구	설명
`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