Mailtrap
公式Mailtrap Email APIと統合します。
Mailtrap MCPで何ができますか?
- トランザクションメールを送信 — 件名とテキストまたはHTML本文を指定して、アシスタントにメールの送信を依頼します。必要に応じて、テンプレートと変数も使用できます。
- Email Sandboxでテスト — サンドボックスにメッセージを送信し、実際の受信者に届くことなく、内容、ヘッダー、添付ファイルを確認できます。
- ログで配信をデバッグ — 送信済みメールのログを一覧表示して絞り込み、特定のメッセージを開いてイベント履歴と配信状況を確認できます。
- 送信統計を分析 — 期間を指定して、配信率、バウンス率、開封率、クリック率、迷惑メール率を取得し、ドメイン、カテゴリ、日付ごとに確認できます。
- テンプレートを管理 — Mailtrapアカウントに保存されたメールテンプレートを作成、一覧表示、更新、削除できます。
- ドメインと抑制リストを管理 — ドメインを一覧表示し、DNS設定手順を取得して、抑制されたアドレスを確認または削除できます。
ドキュメント
Mailtrap 公式 MCP サーバー
メール配信プラットフォーム Mailtrap の公式 MCP サーバーです。Mailtrap アカウントを Claude、Cursor、VS Code、その他の MCP 対応 AI アシスタントに接続します。
自然言語のプロンプトを使って、トランザクションメールや一括メールの送信、Email Sandbox での安全なメッセージテスト、テンプレート、連絡先、ドメイン、Webhook の管理、メールログや配信統計の確認、配信到達性のトラブルシューティング、アカウントリソースの管理を行えます。
機能
- Email API と SMTP — バッチ送信やテンプレートベースのメッセージを含む、トランザクションメールや一括メールを送信します。
- メールのテスト — Email Sandbox でメッセージをテストし、内容、ヘッダー、添付ファイル、スパムスコア、HTML クライアントとの互換性を確認します。
- 配信状況の監視 — メールログを検索し、イベント履歴を確認して、配信、バウンス、開封、クリック、スパム率を分析します。
- メールインフラストラクチャ — ドメイン、DNS 検証、Webhook、抑制リストを管理します。
- 連絡先 — インポートとエクスポートを含め、連絡先、リスト、カスタムフィールド、イベントを管理します。
- アカウント管理 — 請求使用状況を確認し、アクセス権、権限、API トークン、サブアカウントを管理します。
対応 MCP クライアント
Claude Desktop、Claude Code、Cursor、VS Code、およびその他の MCP 対応クライアントで動作します。各クライアントのセットアップ手順は以下のとおりです。
前提条件
この MCP サーバーを使用する前に、以下が必要です。
- Mailtrap アカウントを作成する
- ドメインを検証する
- Mailtrap API 設定から API トークンを取得する
- Mailtrap アカウント管理から Account ID を取得する
- Node.js 22 以降をインストールする。ただし、Docker イメージを実行する場合は不要です。
必須環境変数:
MAILTRAP_API_TOKEN- すべての機能で必須MAILTRAP_ACCOUNT_ID- templates、get-sending-stats、email logs、sandbox list/show、domains、suppressions で必須です。send-email、send-sandbox-email、batch-send-* ツール、email campaign ツール、get-marketing-stats、company info ツール、tracking opt-out ツール、list-accounts では任意です。
任意(ツールのパラメーターとして渡すこともできます):
DEFAULT_FROM_EMAIL- send-email、send-sandbox-email、batch-send-* ツールでfromが指定されていない場合に使用するデフォルトの送信者メールアドレス(base.fromに設定されます)。fromパラメーターを使って、呼び出しごとに送信者を切り替えられます。MAILTRAP_SANDBOX_ID- ツールのsandbox_idが指定されていない場合に使用するデフォルトの sandbox ID(sandbox メッセージの送信、一覧表示、表示ツールでは旧test_inbox_idも引き続き使用できます)。パラメーターを使って、呼び出しごとに sandbox を切り替えられます。MAILTRAP_TEST_INBOX_ID-MAILTRAP_SANDBOX_IDの非推奨エイリアスです。既存の設定との互換性のため、引き続きフォールバックとして読み込まれ、使用時には stderr に非推奨の警告が記録されます。MAILTRAP_ORGANIZATION_ID- 組織ツール(list-sub-accounts、create-sub-account、delete-sub-account)で必須です。MAILTRAP_ORGANIZATION_API_TOKEN- 組織スコープの API トークンです。組織ツールで必須です(MAILTRAP_API_TOKENとは別のトークンです)。
クイックインストール
Docker
Docker MCP Catalog イメージを使って、stdio 経由でサーバーを実行します。
docker run --rm -i \
-e MAILTRAP_API_TOKEN="${MAILTRAP_API_TOKEN}" \
-e MAILTRAP_ACCOUNT_ID="${MAILTRAP_ACCOUNT_ID}" \
-e DEFAULT_FROM_EMAIL="${DEFAULT_FROM_EMAIL}" \
-e MAILTRAP_SANDBOX_ID="${MAILTRAP_SANDBOX_ID}" \
-e MAILTRAP_ORGANIZATION_ID="${MAILTRAP_ORGANIZATION_ID}" \
-e MAILTRAP_ORGANIZATION_API_TOKEN="${MAILTRAP_ORGANIZATION_API_TOKEN}" \
mcp/mailtrap
必須および任意の環境変数については、前提条件を参照してください。
このリポジトリからビルドするには: docker build -t mcp/mailtrap .
Smithery CLI
Smithery は、AI クライアントで利用できる MCP サーバーのレジストリ兼インストーラーです。
公開済みサーバー(mailtrap/mailtrap-mcp)をローカルクライアントにインストールします(必要に応じてクライアント名を置き換えてください)。
npx -y smithery mcp add mailtrap/mailtrap-mcp --client claude
他のクライアント(cursor、windsurf など)や更新の公開については、Smithery CLI ドキュメントを参照してください。
セットアップ
Claude Desktop
MCPB を使って Mailtrap サーバーをインストールします。ファイルはリリースにあります。
Download .MCPB file and open it. If you have Claude Desktop - it will open it and suggest to configure.
Claude Desktop または Cursor
以下の設定を追加します。
{
"mcpServers": {
"mailtrap": {
"command": "npx",
"args": ["-y", "mcp-mailtrap"],
"env": {
"MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
"DEFAULT_FROM_EMAIL": "your_sender@example.com",
"MAILTRAP_ACCOUNT_ID": "your_account_id",
"MAILTRAP_SANDBOX_ID": "your_sandbox_id"
}
}
}
}
Node.js の管理に asdf を使用している場合は、実行ファイルの絶対パスを指定する必要があります(Mac の例)。
{
"mcpServers": {
"mailtrap": {
"command": "/Users/<username>/.asdf/shims/npx",
"args": ["-y", "mcp-mailtrap"],
"env": {
"PATH": "/Users/<username>/.asdf/shims:/usr/bin:/bin",
"ASDF_DIR": "/opt/homebrew/opt/asdf/libexec",
"ASDF_DATA_DIR": "/Users/<username>/.asdf",
"ASDF_NODEJS_VERSION": "22.14.0",
"MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
"DEFAULT_FROM_EMAIL": "your_sender@example.com",
"MAILTRAP_ACCOUNT_ID": "your_account_id",
"MAILTRAP_SANDBOX_ID": "your_sandbox_id"
}
}
}
}
Claude Desktop の設定ファイルの場所
Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Cursor の設定ファイルの場所
Mac: ~/.cursor/mcp.json
Windows: %USERPROFILE%\.cursor\mcp.json
VS Code
設定を手動で変更する
コマンドパレットで次を実行します: Preferences: Open User Settings (JSON)
次に、設定ファイルに以下の設定を追加します。
{
"mcp": {
"servers": {
"mailtrap": {
"command": "npx",
"args": ["-y", "mcp-mailtrap"],
"env": {
"MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
"DEFAULT_FROM_EMAIL": "your_sender@example.com",
"MAILTRAP_ACCOUNT_ID": "your_account_id",
"MAILTRAP_SANDBOX_ID": "your_sandbox_id"
}
}
}
}
}
[!TIP] 「env」セクションを変更した後は、MCP サーバーを再起動してください。
MCP Bundle (MCPB)
MCP Bundle に対応するホストに簡単にインストールできるよう、.mcpb バンドルファイルを配布できます。
# Build TypeScript and pack the MCPB bundle
npm run mcpb:pack
# Inspect bundle metadata
npm run mcpb:info
# Sign the bundle for distribution (optional)
npm run mcpb:sign
これにより mailtrap-mcp.mcpb が作成されます。スクリプトは dist/、manifest.json、icon.png と
ライセンスを mcpb-build/ にコピーし、本番用の依存関係をインストールして、そのディレクトリだけをパッケージ化します。
リポジトリのルートから mcpb pack . を実行しないでください。
使用方法
設定が完了したら、エージェントにメールの送信やテンプレートの管理を依頼できます。たとえば、次のように指示します。
メール送信操作:
- 「john.doe@example.com に、件名を『Meeting Tomorrow』として、近日中の会議について親しみやすくリマインドするメールを送信して」
- 「プロジェクトの進捗について sarah@example.com にメールし、team@example.com のチームを CC に追加して」
- 「ウェルカムテンプレート(uuid
b81aabcd-1a1e-41cf-91b6-eca0254b3d96)を、変数{ name: 'Alex' }を使って new@example.com に送信して」 - 「件名を『Test Template』にして、テスト用メールを test@example.com に送信し、ウェルカムメールの表示を確認して」
メールログ(配信のデバッグ):
- 「最近送信したメールログを一覧表示して」
- 「user@example.com 宛てに送信したメールのログを表示して」
- 「配信状況を確認するため、ID abc-123-uuid のメールログメッセージを取得して」
統計:
- 「2025 年 1 月の送信統計を取得して」
- 「先月のドメイン別の配信率を表示して」
- 「2025-01-01 から 2025-01-31 までのカテゴリ別メール統計を教えて」
- 「先月のメールマーケティングの成果はどうだった?キャンペーンと自動化を比較して」
Sandbox 操作:
- 「自分の sandbox からすべてのメッセージを取得して」
- 「sandbox メッセージの最初のページを表示して」
- 「自分の sandbox で『test』を含むメッセージを検索して」
- 「プロジェクト 42 に『QA』という sandbox を作成して、SMTP 認証情報を教えて」
- 「sandbox 1234 のメッセージをすべて削除して」
- 「ID 5159037506 の sandbox メッセージの詳細を表示して」
テンプレート操作:
- 「Mailtrap アカウントのメールテンプレートをすべて一覧表示して」
- 「件名を『Welcome to our platform!』にして、『Welcome Email』という新しいメールテンプレートを作成して」
- 「ID 12345 のテンプレートの件名を『Updated Welcome Message』に変更して」
- 「ID 67890 のテンプレートを削除して」
ドメイン:
- 「自分のドメインを一覧表示して」
- 「ID 3938 のドメインを取得して」
- 「example.com のドメインを作成して」
- 「ドメイン 3938 のクリックトラッキングを有効にして」
- 「ドメイン 3938 を削除して」
- 「DNS 設定手順とともにドメイン 3938 を取得して」
- 「ドメイン 3938 の会社情報を表示して」
- 「ドメイン 3938 の会社情報を Acme Inc, 123 Main St, San Francisco, US, 94105, https://acme.com に設定して」
- 「ドメイン 3938 の会社情報の市区町村を New York に変更して」
抑制リスト:
- 「bounced@example.com の抑制情報を一覧表示して」
- 「ドメイン 3938 のトランザクションストリームで bounced@example.com を抑制して」
- 「抑制されているメールアドレスをすべて表示して」
- 「user@example.com がメールを受信できない理由を教えて」
- 「user@example.com を抑制リストから削除して」
トラッキングのオプトアウト:
- 「ドメイン 3938 で privacy@example.com の開封とクリックのトラッキングを停止して」
- 「トラッキングをオプトアウトした人を一覧表示して」
連絡先とリスト:
- 「john.doe@example.com をニュースレターの連絡先リストに追加して」
- 「連絡先リストをすべて表示して」
- 「連絡先の登録元を追跡するため、『signup_source』という連絡先フィールドを作成して」
- 「john.doe@example.com のプランを『pro』に設定して」
- 「この CSV からオンボーディングリストに連絡先をインポートして」
- 「ニュースレターリストの連絡先をすべてエクスポートして」
- 「john.doe@example.com の連絡先について『trial_started』イベントを記録して」
Webhook:
- 「アカウントに設定されている Webhook をすべて一覧表示して」
- 「バウンスとスパムのイベントを https://example.com/hooks/mailtrap に送信する Webhook を作成して」
- 「Webhook 4821 に配信イベントも送信するよう設定して」
- 「Webhook 4821 を削除して」
アカウントと請求:
- 「今月の請求使用状況を教えて」
- 「プランであと何通メールを送信できる?」
- 「この Mailtrap アカウントにアクセスできる人を一覧表示して」
- 「アカウントで利用可能な権限リソースを表示して」
API トークン:
- 「アカウントの API トークンをすべて一覧表示して」
- 「ステージング環境用の新しい API トークンを作成して」
- 「ID 1234 の API トークンをリセットして」
- 「未使用の API トークン 1234 を削除して」
組織とサブアカウント:
- 「組織内のサブアカウントをすべて一覧表示して」
- 「クライアントプロジェクト『Acme Corp』用の新しいサブアカウントを作成して」
名前が変更されたツール
Mailtrap では、テスト用受信トレイをサンドボックス、送信ドメインをドメインと呼ぶようになり、ツール名もそれに合わせて変更されました。古い名前はツール一覧に表示されなくなりましたが、古い名前での呼び出しは引き続き動作し、stderr に非推奨の警告が記録されます。今後のメジャーリリースで削除される予定です。
MCP クライアントとエージェントフレームワークは、許可、拒否、フィルターのリストを公開されているツール名と照合します。そのため、ツールごとの設定を新しい名前に移してください。delete-sending-domain に対する拒否エントリでは、delete-domain はブロックされなくなります。
| 旧名 | 新しい名前 |
|---|---|
create-sandbox-inbox | create-sandbox |
get-sandbox-inbox | get-sandbox |
update-sandbox-inbox | update-sandbox |
delete-sandbox-inbox | delete-sandbox |
clean-sandbox-inbox | clean-sandbox |
list-sending-domains | list-domains |
get-sending-domain | get-domain |
create-sending-domain | create-domain |
update-sending-domain | update-domain |
delete-sending-domain | delete-domain |
send-sending-domain-setup-instructions | send-domain-setup-instructions |
sending_domain_id ドメインおよび会社情報ツールのパラメーター | domain_id |
MAILTRAP_TEST_INBOX_ID 環境変数 | MAILTRAP_SANDBOX_ID |
API フィールドに対応するフィルター名は変更されません。list-email-logs の sending_domain_id と、統計ツールの sending_domain_ids が該当します。
利用可能なツール
send-email
Mailtrap 経由でトランザクションメールを送信します。相互排他的な 2 つのモードに対応しています — インラインコンテンツ(subject + text/html)またはテンプレートベース(template_uuid)。
パラメーター:
from(任意):{ email, name? }としての送信者(実行時にはメールアドレス文字列のみも受け付けます)。指定しない場合はDEFAULT_FROM_EMAILが使用されます。to(任意):{ email, name? }オブジェクトの受信者配列(実行時にはメールアドレス文字列のみ、または配列ではない単一のアドレスも受け付けます)。ccまたはbccが指定されている場合は省略可能です。to/cc/bccの少なくとも1つに受信者を含める必要があります。cc(任意):{ email, name? }オブジェクトの CC 受信者配列(実行時にはメールアドレス文字列のみも受け付けます)。bcc(任意):{ email, name? }オブジェクトの BCC 受信者配列(実行時にはメールアドレス文字列のみも受け付けます)。subject(条件付き): メールの件名。インライン送信では必須です。template_uuidが設定されている場合は省略してください。text(条件付き): メール本文のテキスト。インライン送信ではhtmlと併せて、またはその代わりに必須です。template_uuidが設定されている場合は省略してください。html(条件付き): メール本文の HTML 版。インライン送信ではtextと併せて、またはその代わりに必須です。template_uuidが設定されている場合は省略してください。category(任意): トラッキングと分析用のメールカテゴリ。template_uuidが設定されている場合は省略してください。template_uuid(任意): インラインコンテンツの代わりに Mailtrap のメールテンプレートを使用します。設定する場合、Mailtrap API の仕様によりsubject/text/html/categoryは省略してください。template_variables(任意):template_uuidが参照するテンプレートに代入する変数のオブジェクト。template_uuidと併用する場合にのみ指定できます。
batch-send-transactional-email
Mailtrap API を1回呼び出して、トランザクションメールを一括送信します(デフォルトの送信ストリーム)。共通フィールドは base に、受信者ごとの上書き値は requests[] に指定します。各リクエストには、to、cc、bcc のいずれかを使って、少なくとも1人の受信者を指定する必要があります。send-email と同じインラインとテンプレートの相互排他ルールが適用されます。ベース値と各リクエストをマージした後に検証されます。
パラメーター:
base(任意): バッチ内で共有するフィールドを含むオブジェクト。from(任意):{ email, name? }としての送信者(実行時にはメールアドレス文字列のみも受け付けます)。指定しない場合はDEFAULT_FROM_EMAILにフォールバックします。reply_to(任意): 返信先アドレス。subject/text/html/category(任意、インラインモード): 各リクエストのデフォルトコンテンツ。template_uuid/template_variables(任意、テンプレートモード): デフォルトのテンプレートと変数。インラインフィールドとは併用できません。custom_variables(任意): デフォルトのカスタム変数(文字列値)。headers(任意): デフォルトのカスタムヘッダー。
requests(必須): 受信者ごとのメッセージを含む空でない配列。各エントリには以下を指定します。to(任意):{ email, name? }オブジェクトの受信者配列(実行時にはメールアドレス文字列のみ、または配列ではない単一のアドレスも受け付けます)。ccまたはbccが指定されている場合は省略可能です。to/cc/bccの少なくとも1つに受信者を含める必要があります。cc、bcc、reply_to(任意)。- インライン (
subject/text/html/category) またはテンプレート (template_uuid/template_variables) の上書き値。省略したフィールドは、対応するbaseの値にフォールバックします。 custom_variables、headers(任意)。
batch-send-bulk-email
Mailtrap の一括送信ストリーム API を通じて、バルクメールを一括送信します。batch-send-transactional-email と同じ base + requests[] の形式、検証、インラインとテンプレートのルールが適用されます。異なるのは、このツールがトランザクション用ではなく一括送信用のエンドポイントを通じて呼び出す点だけです。上記のパラメーターを参照してください。
list-email-logs
送信済みメールのログ(配信履歴)を、ページネーションやフィルターを指定して一覧表示します。IDE を離れずに配信の問題をデバッグできます。
パラメーター:
search_after(任意): 前回のレスポンスのnext_page_cursorから取得したページネーションカーソルsent_after(任意): ISO 8601 の日時。この日時より後に送信されたログのみsent_before(任意): ISO 8601 の日時。この日時より前に送信されたログのみfrom_email(任意): 送信者のメールアドレスでフィルターします。from_operatorと併用します(デフォルト: ci_equal)to_email(任意): 受信者のメールアドレスでフィルターします。to_operatorと併用します(デフォルト: ci_equal)status(任意): 配信ステータスでフィルターします: delivered、not_delivered、enqueued、opted_out。status_operatorと併用します(デフォルト: equal)subject(任意): メールの件名でフィルターします。subject_operatorと併用します(デフォルト: ci_contain)。件名の有無でフィルターするには、subject_operatorに empty/not_empty を指定します。sending_domain_id(任意): ドメイン ID(数値)でフィルターします。sending_domain_id_operatorと併用します(デフォルト: equal)sending_stream(任意): ストリームでフィルターします: transactional または bulk。sending_stream_operatorと併用します(デフォルト: equal)events(任意): イベントタイプでフィルターします: delivery、open、click、bounce、spam、unsubscribe、soft_bounce、reject、suspension。events_operatorと併用します(include_event / not_include_event)clicks_count/opens_count(任意): クリック数または開封数でフィルターします。*_operatorに equal、greater_than、less_than を指定します。client_ip/sending_ip(任意): IP でフィルターします。*_operatorに equal、not_equal、contain、not_contain を指定します。email_service_provider_response(任意): プロバイダーの応答テキストでフィルターします。*_operatorに ci_contain などを指定します。email_service_provider(任意): プロバイダー(完全一致)でフィルターします。*_operatorに equal、not_equal を指定します。recipient_mx(任意): 受信者の MX でフィルターします。recipient_mx_operatorに ci_contain などを指定します。category(任意): メールカテゴリでフィルターします。category_operatorに equal、not_equal を指定します。
すべてのパラメーターは任意です。
get-email-log-message
ID(UUID)で単一のメールログメッセージを取得します。読みやすい概要(送信元、宛先、件名、送信時刻、ステータス、カテゴリ、ストリーム、エンゲージメント、配信コンテキスト)に続いて、詳細なイベント履歴を表示します。include_content: true を指定すると、Mailtrap が生メッセージ URL を公開している場合に、メッセージ本文(HTML とプレーンテキスト)も読み込んで表示できます。
パラメーター:
message_id(必須): メールログメッセージの UUID(送信レスポンスまたは list-email-logs から取得)。メッセージ ID を探すにはlist-email-logsを使用します。include_content(任意):trueの場合、(raw_message_urlが利用可能であれば)生の EML を取得し、show-sandbox-email-message と同様に、解析した HTML とプレーンテキストの本文セクションを追加します。
get-sending-stats
指定した期間のメール送信統計(配信率、バウンス率、開封率、クリック率、スパム率)を取得します。ドメイン、カテゴリ、メールサービスプロバイダー、または日付ごとの内訳も指定できます。エディターを離れずに配信率を確認できます。
パラメーター:
start_date(必須): 統計期間の開始日(YYYY-MM-DD)end_date(必須): 統計期間の終了日(YYYY-MM-DD)breakdown(任意): 統計の内訳方法:aggregated(デフォルト)、by_domain、by_category、by_email_service_provider、またはby_datesending_domain_ids(任意): 指定したドメイン ID(整数の配列)に結果を限定しますsending_streams(任意):transactionalおよび/またはbulkに限定します(文字列の配列)categories(任意): 指定したメールカテゴリに結果を限定します(文字列の配列)email_service_providers(任意): 指定したプロバイダー(例: Google、Yahoo、Outlook)に結果を限定します(文字列の配列)
get-marketing-stats
指定した期間のキャンペーンと自動化に関する Email Marketing の集計統計を取得します。送信数、配信数、バウンス数、開封数、クリック数、スパム数、配信停止数とその割合が含まれます。delivery_rate と bounce_rate は sent_count に対する割合です。それ以外の割合は delivery_count に対する割合です。
パラメーター:
start_date(必須): 期間の開始日(この日を含む)、YYYY-MM-DDend_date(必須): 期間の終了日(この日を含む)、YYYY-MM-DDsending_domain_ids(任意): 指定したドメイン ID(整数の配列)に結果を限定しますsources(任意):campaignsまたはautomationsを指定すると、そのソースの統計に絞り込まれます。省略するか両方を渡すと、すべての Email Marketing トラフィックが対象になります(文字列の配列)email_service_providers(任意): 指定したプロバイダー(例: Google、Yahoo、Outlook)に結果を限定します(文字列の配列)
create-template
Mailtrap アカウントに新しいメールテンプレートを作成します。
パラメーター:
name(必須): テンプレート名subject(必須): メールの件名htmlまたはtextが必須: テンプレートの HTML コンテンツtextまたはhtmlが必須: テンプレートのプレーンテキスト版category(任意): テンプレートカテゴリ(デフォルトは "General")
list-templates
Mailtrap アカウントのメールテンプレートを、ページトークン方式のページネーションで一覧表示します。テンプレートがさらにある場合、結果に次のページの token が示されます。ページは新しい順のリストに対するオフセットです。そのため、テンプレートを削除した後は次のトークンを続けて使わず、token 1 から再度一覧表示してください。空のページには、テンプレートが残っている最後のページが示されます。
パラメーター:
token(任意): 取得するページ番号(ページトークン方式のページネーション)。デフォルトは1per_page(任意): 1ページあたりのテンプレート数。デフォルトは50、最大は100です。すべてのページで同じ値を指定してください。
get-template
ID で単一のメールテンプレートを取得します。件名、カテゴリ、HTML/テキスト本文が含まれます。
パラメーター:
template_id(必須): 取得するテンプレートの ID
update-template
既存のメールテンプレートを更新します。
パラメーター:
template_id(必須): 更新するテンプレートの IDname(任意): テンプレートの新しい名前subject(任意): 新しいメールの件名html(任意): テンプレートの新しい HTML コンテンツtext(任意): テンプレートの新しいプレーンテキスト版category(任意): テンプレートの新しいカテゴリ
[!NOTE] update-template を呼び出して更新するには、更新可能なフィールド(name、subject、html、text、category)のうち少なくとも1つを指定する必要があります。
delete-template
既存のメールテンプレートを削除します。
パラメーター:
template_id(必須): 削除するテンプレートの ID
send-sandbox-email
開発やテスト用に、Mailtrap のサンドボックスへメールを送信します。実際の受信者にメールを送らずにメールテンプレートをテストするのに最適です。send-email と同じ2つのモード、つまり インラインコンテンツ または テンプレートベース (template_uuid) に対応しています。
パラメーター:
sandbox_id(任意): 推奨。Mailtrap サンドボックス ID。MAILTRAP_SANDBOX_IDが設定されていない場合は必須です。test_inbox_id(任意):sandbox_idが省略されている場合の、sandbox_idの旧式エイリアス。from(任意):{ email, name? }としての送信者(実行時にはメールアドレスのみの文字列も受け付けます)。指定されていない場合はDEFAULT_FROM_EMAILが使用されます。to(任意):{ email, name? }オブジェクトとしての宛先の配列(配列内のメールアドレスのみの文字列、またはカンマ区切りのメールアドレス文字列も実行時に受け付けます)。ccまたはbccが指定されている場合は省略可能です。to/cc/bccの少なくとも1つに宛先を含める必要があります。cc(任意):{ email, name? }オブジェクトとしての CC 宛先の配列(メールアドレスのみの文字列も実行時に受け付けます)。bcc(任意):{ email, name? }オブジェクトとしての BCC 宛先の配列(メールアドレスのみの文字列も実行時に受け付けます)。subject(条件付き): メールの件名。インライン送信では必須です。template_uuidが設定されている場合は省略する必要があります。text(条件付き): メール本文のテキスト。インライン送信では必須です(htmlと併用するか、どちらか一方を指定)。template_uuidが設定されている場合は省略する必要があります。html(条件付き): メール本文の HTML 版。インライン送信では必須です(textと併用するか、どちらか一方を指定)。template_uuidが設定されている場合は省略する必要があります。category(任意): トラッキング用のメールカテゴリ。template_uuidが設定されている場合は省略する必要があります。template_uuid(任意): インラインコンテンツの代わりに Mailtrap のメールテンプレートを使用します。設定されている場合、subject/text/html/categoryは省略する必要があります。template_variables(任意):template_uuidが参照するテンプレートに代入する変数のオブジェクト。template_uuidと併用する場合にのみ指定できます。
batch-send-sandbox-email
実際の宛先には配信せず、1回の API 呼び出しで Mailtrap サンドボックスにメールを一括送信します。batch-send-transactional-email と同じ base + requests[] の形式、検証、およびインライン送信とテンプレート送信のルールが適用されます。異なるのは、このツールが単一のサンドボックス用のサンドボックスエンドポイント経由で呼び出しをルーティングする点です。
パラメーター:
sandbox_id(任意): Mailtrap サンドボックス ID。MAILTRAP_SANDBOX_IDが設定されていない場合は必須です。特定のサンドボックスを対象にするには、呼び出しごとに渡します。base(任意)、requests(必須): 上記のbatch-send-transactional-emailを参照してください。
[!NOTE] ほとんどのサンドボックスツールでは
sandbox_idを使用します(またはMAILTRAP_SANDBOX_IDにフォールバックします。非推奨の環境変数MAILTRAP_TEST_INBOX_IDも引き続き使用できます)。send-sandbox-email、get-sandbox-messages、show-sandbox-email-messageも旧式のtest_inbox_idを受け付けます。get-sandbox、update-sandbox、delete-sandbox、clean-sandboxは、旧式のinbox_idとともにsandbox_idを使用します(同じ ID です。メッセージツールではinbox_idは使用されません)。受信メールツールでは、サンドボックスではなく別の製品(受信メール)用のinbox_idを使用します。
get-sandbox-messages
Mailtrap サンドボックスからメッセージの一覧を取得します。テスト中にサンドボックスで受信したメールを確認するのに便利です。
パラメーター:
sandbox_id(任意): 推奨。MAILTRAP_SANDBOX_IDが設定されていない場合のサンドボックス ID。test_inbox_id(任意):sandbox_idの旧式エイリアス。page(任意): ページネーション用のページ番号(最小値: 1)last_id(任意): 最後のメッセージ ID を使用したページネーション。指定したメッセージ ID より後のメッセージを返します(最小値: 1)search(任意): メッセージを絞り込む検索クエリ
[!NOTE]
MAILTRAP_SANDBOX_IDが設定されている場合、サンドボックス ID パラメーターは省略可能です。sandbox_id、test_inbox_id、環境変数のいずれも指定されていない場合、呼び出しは失敗します。ページネーションには、必要に応じてpage、last_id、またはsearchを使用してください。
show-sandbox-email-message
Mailtrap サンドボックス内の特定のメールメッセージについて、HTML とテキストの本文を含む詳細情報と内容を表示します。
パラメーター:
sandbox_id(任意): 推奨。MAILTRAP_SANDBOX_IDが設定されていない場合のサンドボックス ID。test_inbox_id(任意):sandbox_idの旧式エイリアス。message_id(必須): 取得するサンドボックスメールメッセージの ID
[!NOTE] まず
get-sandbox-messagesを使用してメッセージ ID を取得し、その後このツールで内容全体を確認してください。
list-sandbox-projects
すべてのサンドボックスプロジェクトと、それぞれのサンドボックスを一覧表示します。
パラメーター:
- パラメーターは不要です
create-sandbox-project
サンドボックスをまとめる新しいサンドボックスプロジェクトを作成します。
パラメーター:
name(必須): プロジェクト名(2~100文字)
get-sandbox-project
ID でサンドボックスプロジェクトを取得します。サンドボックスとメール件数も含まれます。
パラメーター:
project_id(必須): 取得するプロジェクトの ID
update-sandbox-project
既存のサンドボックスプロジェクトの名前を変更します。
パラメーター:
project_id(必須): 更新するプロジェクトの IDname(必須): プロジェクトの新しい名前(2~100文字)
delete-sandbox-project
サンドボックスプロジェクトと、そのすべてのサンドボックスを削除します。
パラメーター:
project_id(必須): 削除するプロジェクトの ID
create-sandbox
プロジェクト内に新しいサンドボックスを作成します。新しいサンドボックスの SMTP 認証情報を返します。
パラメーター:
project_id(必須): サンドボックスを作成するプロジェクトの IDname(必須): サンドボックス名
get-sandbox
SMTP 認証情報、メール件数、ステータスなどのサンドボックスの詳細を取得します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDが設定されていない場合は必須です。inbox_id(任意):sandbox_idの旧式エイリアス。
update-sandbox
サンドボックスの名前またはメールユーザー名を更新します。
パラメーター:
sandbox_id(必須): サンドボックス ID(旧式エイリアス:inbox_id)name(任意): サンドボックスの新しい名前email_username(任意): サンドボックスの新しいメールユーザー名
name または email_username の少なくとも一方を指定する必要があります。
delete-sandbox
サンドボックスと、そのすべてのメッセージを削除します。
パラメーター:
sandbox_id(必須): サンドボックス ID(旧式エイリアス:inbox_id)
clean-sandbox
サンドボックス自体は削除せず、サンドボックス内のすべてのメッセージを削除します。
パラメーター:
sandbox_id(必須): サンドボックス ID(旧式エイリアス:inbox_id)
list-sandboxes
すべてのプロジェクトにわたり、API トークンからアクセスできるすべてのサンドボックスを一覧表示します。
パラメーター:
- パラメーターは不要です
mark-sandbox-as-read
サンドボックス内のすべてのメッセージを既読にします。
パラメーター:
sandbox_id(必須): 操作対象のサンドボックス ID
reset-sandbox-credentials
サンドボックスの SMTP 認証情報をリセットします。新しいユーザー名とパスワードを返します。
パラメーター:
sandbox_id(必須): 操作対象のサンドボックス ID
enable-sandbox-email-address
サンドボックスのメール受信アドレスを有効にします(SMTP 経由でメッセージをサンドボックスに配信する Mailtrap アドレスを有効化します)。
パラメーター:
sandbox_id(必須): 操作対象のサンドボックス ID
reset-sandbox-email-address
サンドボックスの新しいメール受信アドレスを生成します。
パラメーター:
sandbox_id(必須): 操作対象のサンドボックス ID
forward-sandbox-message
サンドボックスのメッセージを外部のメールアドレスに転送します。月間転送上限にカウントされます。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): 転送するサンドボックスメッセージの IDemail(必須): メッセージの転送先メールアドレス
update-sandbox-message
サンドボックスメッセージを既読または未読にします。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): 更新するサンドボックスメッセージの IDis_read(必須):trueは既読にし、falseは未読にします
delete-sandbox-message
サンドボックスメッセージを1件削除します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): 削除するサンドボックスメッセージの ID
get-sandbox-message-spam-score
サンドボックスメッセージの SpamAssassin スパムレポート(スコア、ルール、完全なレポート)を取得します。show-sandbox-email-message 上の include_spam_report: true に代わる単独のツールです。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-html-analysis
サンドボックスメッセージの HTML 分析レポート(クライアント互換性スコア、問題のある要素)を取得します。show-sandbox-email-message 上の include_html_analysis: true に代わる単独のツールです。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-headers
サンドボックスメッセージの解析済みメールヘッダーを取得します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-html
サンドボックスメッセージのレンダリング済み HTML 本文を取得します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-text
サンドボックスメッセージのプレーンテキスト本文を取得します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-raw
サンドボックスメッセージの MIME 形式の生データ(ヘッダー + 本文)を取得します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-eml
メッセージを EML ファイルのペイロードとしてレンダリングして取得します(チケットへの添付や、別のメールクライアントへのインポートに適しています)。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-message-html-source
サンドボックスメッセージの未レンダリング HTML ソースを取得します(CID リンクの書き換えなど、Mailtrap 側での変換前の HTML)。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
list-sandbox-attachments
サンドボックスメッセージのすべての添付ファイルを一覧表示します(ファイル名、コンテンツタイプ、サイズ、ダウンロードパス)。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): サンドボックスメッセージの ID
get-sandbox-attachment
単一の添付ファイルのメタデータとダウンロード URL を取得します。
パラメーター:
sandbox_id(任意): サンドボックス ID。MAILTRAP_SANDBOX_IDにフォールバックします。message_id(必須): 添付ファイルを含むサンドボックスメッセージの IDattachment_id(必須): 取得する添付ファイルの ID
list-domains
ドメインと DNS 検証ステータスを一覧表示します。
パラメーター:
- パラメーターは不要です
get-domain
ID でドメインとその検証ステータス(DNS レコードを含む)を取得します。include_setup_instructions を true に設定すると、DNS 設定手順を含めることができます。
パラメーター:
domain_id(必須): ドメイン ID(旧式エイリアス:sending_domain_id)include_setup_instructions(任意):trueの場合、DNS 設定手順をレスポンスに追加します。デフォルト:false
create-domain
新しいドメインを作成します。作成後、DNS レコードを追加してドメインを検証してください(レコードを確認するには、include_setup_instructions: true を指定して get-domain を使用します)。
パラメーター:
domain_name(必須): ドメイン名(例: example.com)
update-domain
ドメインのトラッキング設定と受信設定を更新します。
パラメーター:
domain_id(必須): ドメイン ID(旧エイリアス:sending_domain_id)open_tracking_enabled(任意): このドメインから送信されたメールの開封を追跡するclick_tracking_enabled(任意): このドメインから送信されたメール内のリンクのクリックを追跡するtracking_opt_out_enabled(任意): 追跡対象のメールにトラッキングのオプトアウトリンクを追加する。開封またはクリックの追跡が必要ですauto_unsubscribe_link_enabled(任意): メールに配信停止リンクを自動的に追加するinbound_enabled(任意): このドメインをキャッチオールとして受信トレイに割り当てられるようにする
domain_id 以外に、少なくとも1つの設定を指定する必要があります。
delete-domain
ドメインを削除します。
パラメーター:
domain_id(必須): 削除するドメイン ID(旧エイリアス:sending_domain_id)
send-domain-setup-instructions
ドメインの DNS 設定手順を指定したアドレスにメールで送信します。DNS レコードを DevOps チームのメンバーに転送する場合に便利です。
パラメーター:
domain_id(必須): ドメイン ID(旧エイリアス:sending_domain_id)email(必須): DNS 設定手順の送信先メールアドレス
get-company-info
ドメインのコンプライアンス確認に使用する、ドメインの会社情報を取得します。
パラメーター:
domain_id(必須): ドメイン ID(旧エイリアス:sending_domain_id)
create-company-info
ドメインのコンプライアンス確認に必要な、ドメインの会社情報を設定します。
パラメーター:
domain_id(必須): ドメイン ID(旧エイリアス:sending_domain_id)name(必須): 会社名または個人名address(必須): 住所city(必須): 市区町村country(必須): 国zip_code(必須): ZIP コードまたは郵便番号website_url(必須): 会社のウェブサイト URLphone(任意): 電話番号privacy_policy_url(任意): プライバシーポリシーページの URLterms_of_service_url(任意): 利用規約ページの URLinfo_level(任意):businessまたはindividual
update-company-info
ドメインの会社情報を更新します。
パラメーター:
domain_id(必須): ドメイン ID(旧エイリアス:sending_domain_id)- create-company-info のすべてのフィールド(任意)。少なくとも1つ指定する必要があります。省略したフィールドは変更されません。
list-suppressions
抑制対象(ハードバウンス、迷惑メール報告、配信停止、手動インポート)を一覧表示または検索します。1回の呼び出しにつき最大1000件を返します。
パラメーター:
email(任意): メールアドレスのフィルター。このアドレスに一致する抑制対象のみを返します。
create-suppression
アカウントの抑制リストにメールアドレスを追加し、Mailtrap からそのアドレスへの配信を停止します。
パラメーター:
email(必須): 抑制するメールアドレスdomain_id(必須): 抑制を適用するドメインの IDsending_stream(必須):transactionalまたはbulktype(任意):hard bounce、spam complaint、unsubscription、またはmanual import。デフォルトはmanual import
delete-suppression
ID を指定して抑制対象を削除します。再び抑制対象にならない限り、Mailtrap はこのメールアドレスへの配信を再開します。
パラメーター:
suppression_id(必須): 削除する抑制対象の ID
list-tracking-opt-outs
開封およびクリックの追跡対象から除外されたメールアドレスを一覧表示します。1回の呼び出しにつき最大1000件を返します。
パラメーター:
email(任意): メールアドレスのフィルター。このアドレスに一致するオプトアウトのみを返しますstart_time(任意): この時刻以降に作成されたオプトアウトのみ(ISO 8601)end_time(任意): この時刻以前に作成されたオプトアウトのみ(ISO 8601)last_id(任意): ページネーションカーソル — 前回のレスポンスのlast_id
create-tracking-opt-out
ドメインの開封およびクリックの追跡対象からメールアドレスを除外します。
パラメーター:
email(必須): トラッキングをオプトアウトするメールアドレスdomain_id(必須): オプトアウトを適用するドメインの ID
delete-tracking-opt-out
トラッキングのオプトアウトリストからメールアドレスを削除し、開封およびクリックの追跡を再び適用します。
パラメーター:
tracking_opt_out_id(必須): 削除するトラッキングオプトアウトの ID
list-webhooks
アカウントに設定されているすべての Webhook を一覧表示します。Webhook レコード全体を JSON 形式で返します。
パラメーター:
- パラメーターは不要です
get-webhook
ID を指定して単一の Webhook を取得します。Webhook レコード全体を JSON 形式で返します。注: signing_secret はここでは返されません。create-webhook のレスポンスでのみ取得できます。
パラメーター:
webhook_id(必須): 取得する Webhook の ID
create-webhook
Webhook を作成します。レスポンスには、Webhook ペイロードの署名を検証するための signing_secret が含まれます。このシークレットが返されるのは作成時のみなので、今すぐ保存してください。紛失した場合は、Webhook を再作成してください。
パラメーター:
url(必須): Mailtrap が Webhook イベントを POST する URLwebhook_type(必須):"email_sending"、"audit_log"、または"inbound_receiving"active(任意、boolean): デフォルトはtruepayload_format(任意):"json"または"jsonlines"。デフォルトは"json"sending_stream(任意、email_sendingのみ):"transactional"または"bulk"event_types(任意、email_sendingのみ):delivery、soft_bounce、bounce、suspension、unsubscribe、open、spam_complaint、click、rejectの配列domain_id(任意、email_sendingのみ): この Webhook の対象を限定するドメイン IDinbound_inbox_id(任意、inbound_receivingのみ): Webhook が関連付けられている受信トレイの ID。省略すると、アカウント内のすべての受信トレイに適用されます
update-webhook
Webhook の変更可能なフィールドを更新します。webhook_type、sending_stream、domain_id は作成後に変更できません。これらを変更する必要がある場合は、Webhook を再作成してください。
パラメーター:
webhook_id(必須): 更新する Webhook の IDurl(任意): 新しい Webhook URLactive(任意、boolean): Webhook を有効または無効にするpayload_format(任意):"json"または"jsonlines"event_types(任意、email_sendingのみ):delivery、soft_bounce、bounce、suspension、unsubscribe、open、spam_complaint、click、rejectの配列inbound_inbox_id(任意、inbound_receivingのみ): Webhook が関連付けられている受信トレイの ID
delete-webhook
ID を指定して Webhook を完全に削除します。削除された Webhook レコードを返します。
パラメーター:
webhook_id(必須): 削除する Webhook の ID
get-contact
ID またはメールアドレスを指定して連絡先を取得します。連絡先レコード全体(リストへの登録状況、ステータス、カスタムフィールド)を返します。
パラメーター:
contact_identifier(必須): 連絡先 ID またはメールアドレス
create-contact
新しい連絡先を作成します。
パラメーター:
email(必須): メールアドレスfields(任意): マージタグをキーとするカスタムフィールド値(例:first_name)。値は文字列、数値、または booleanlist_ids(任意): この連絡先を登録する連絡先リストの IDunsubscribed(任意、boolean):unsubscribedステータスで連絡先を作成する
update-contact
ID またはメールアドレスで特定した既存の連絡先を更新します。list_ids は連絡先の登録リスト全体を置き換えます。list_ids_included/list_ids_excluded は、ほかの登録状況を変更せずに追加または削除します。
パラメーター:
contact_identifier(必須): 連絡先 ID またはメールアドレスemail(任意): 新しいメールアドレスfields(任意): マージタグをキーとするカスタムフィールド値list_ids(任意): 登録リストをこのリストに完全に置き換えるlist_ids_included(任意): 追加するリスト ID(追加のみ)list_ids_excluded(任意): 削除するリスト IDunsubscribed(任意、boolean):unsubscribed(true)またはsubscribed(false)に設定する
delete-contact
ID またはメールアドレスを指定して連絡先を完全に削除します。API が削除された連絡先レコードを返す場合はそのレコードを、返さない場合は確認用ペイロードを返します。
パラメーター:
contact_identifier(必須): 連絡先 ID またはメールアドレス
create-contact-event
連絡先(ID またはメールアドレスで指定)に対するイベントを記録します。連絡先リストの自動化をトリガーするために使用します。
パラメーター:
contact_identifier(必須): 連絡先 ID またはメールアドレスname(必須): イベント名(自動化のトリガーと一致)params(必須): 任意のキーと値のペアを含むオブジェクト。値は文字列、数値、boolean、または null
list-contact-lists
アカウントのすべての連絡先リストを一覧表示します。
パラメーター:
search(任意): 名前で連絡先リストを絞り込みます(大文字と小文字を区別しない一致)。例:news
get-contact-list
ID を指定して連絡先リストを取得します。
パラメーター:
list_id(必須): 取得する連絡先リストの ID
create-contact-list
新しい連絡先リストを作成します。
パラメーター:
name(必須): 新しいリストの名前
update-contact-list
既存の連絡先リストの名前を変更します。
パラメーター:
list_id(必須): 連絡先リストの IDname(必須): リストの新しい名前
delete-contact-list
ID を指定して連絡先リストを完全に削除します。
パラメーター:
list_id(必須): 削除する連絡先リストの ID
list-contact-fields
アカウントのすべての連絡先フィールド定義を一覧表示します。
パラメーター:
- パラメーターは不要です
get-contact-field
ID を指定して連絡先フィールド定義を取得します。
パラメーター:
field_id(必須): 連絡先フィールドの ID
create-contact-field
新しい連絡先フィールド定義を作成します。merge_tag はアカウント内で一意である必要があり、テンプレート変数のプレースホルダー名として使用されます。
パラメーター:
name(必須): 表示名(例: "First Name")merge_tag(必須): 一意のプレースホルダー名(例:first_name)data_type(必須):text、number、boolean、dateのいずれか
update-contact-field
連絡先フィールド定義を更新します。name、merge_tag、data_type は任意の組み合わせで変更できます。
パラメーター:
field_id(必須): 連絡先フィールドの IDname(任意): 新しい表示名merge_tag(任意): 新しいマージタグ(一意性を維持する必要があります)data_type(任意):text、number、boolean、dateのいずれか
delete-contact-field
ID を指定して連絡先フィールド定義を完全に削除します。
パラメーター:
field_id(必須): 削除する連絡先フィールドの ID
create-contact-import
連絡先を一括インポートします。インポートジョブのレコードを返します。get-contact-import でステータスを確認してください。
パラメーター:
contacts(必須): 連絡先エントリの配列。各エントリには以下が必要です:email(必須): 連絡先のメールアドレスfields(任意): マージタグをキーとするカスタムフィールド値(文字列または数値)list_ids_included(任意): 連絡先を追加するリスト IDlist_ids_excluded(任意): 連絡先を削除するリスト ID
get-contact-import
連絡先インポートジョブのステータス(created/started/finished/failed)と、作成数、更新数、上限超過数を取得します。
パラメーター:
import_id(必須): 連絡先インポートジョブの ID
create-contact-export
AND 条件で組み合わせた一連のフィルターに一致する連絡先をエクスポートします。エクスポートジョブのレコードを返します。status が finished になったら、get-contact-export でステータスを確認してダウンロード URL を取得してください。
パラメーター:
filters(必須): フィルターオブジェクトの配列。各オブジェクトには以下が含まれます:name(必須): フィルター対象のフィールド (list_id、subscription_status、emailなど)operator(必須):equal、not_equal、contains、not_contains、is_empty、is_not_emptyのいずれかvalue(必須): 比較値 (文字列、数値、ブール値、または配列)
get-contact-export
連絡先エクスポートジョブのステータスを取得します。status が finished になると、url フィールドに CSV のダウンロードリンクが格納されます。
パラメーター:
export_id(必須): 連絡先エクスポートジョブの ID
list-email-campaigns
アカウントのメールキャンペーンを新しい順に一覧表示します。ページトークンによるページネーションに対応しています。search で名前による絞り込みもできます。
パラメーター:
token(任意): 取得するページ番号 (ページトークンによるページネーション)。デフォルトは1per_page(任意): 1 ページあたりのキャンペーン数。デフォルトは50、最大は100search(任意): キャンペーンを名前で絞り込みます (大文字と小文字を区別しない部分一致)
get-email-campaign
ID でメールキャンペーンを取得します。
パラメーター:
email_campaign_id(必須): メールキャンペーンの ID
create-email-campaign
新しいメールキャンペーンを作成します。キャンペーンは常に draft 状態で作成されます。スケジュール設定と開始には別のツール (schedule-email-campaign、start-email-campaign) を使用します。
パラメーター:
name(必須): キャンペーン名domain_id(必須): キャンペーンに使用する検証済みドメインの ID。list-domainsが返す値ですfrom_local_part(必須): From アドレスの @ より前の部分template_attributes(必須): インラインメールテンプレート。以下が含まれます:subject(必須): メールの件名 (最大 255 文字)。Hi {{first_name}}などのマージタグに対応していますbody_html(任意): HTML 本文 (デザイン)。キャンペーンのスケジュール設定または開始前に必須です。__unsubscribe_url__プレースホルダーを含むhref属性を持つアンカーを使って、配信停止リンクを含めてくださいbody_text(任意): メール本文のプレーンテキスト版merge_tags(任意): 件名または本文で参照されるマージタグの名前 (プレフィックスなし)。例:["first_name"]
from_display_name(任意): From ヘッダーに表示する名前reply_to(任意): Reply-To アドレスの各部分 (display_name、local_part、domain)delivery_mode(任意):rapid(可能な限り速く送信) またはgradual(delivery_options.emails_per_hourに制限)delivery_options(任意): 配信速度の制限オプション (emails_per_hour)contact_list_ids(任意): 送信先の連絡先リスト ID (指定したリスト全体が対象として扱われます)contact_segment_ids(任意): 送信先の連絡先セグメント ID (指定したセグメント全体が対象として扱われます)
update-email-campaign
draft 状態のメールキャンペーンを更新します。指定したフィールドのみが変更され、テンプレートはその場で編集されます。それ以外の状態のキャンペーンは更新できません。
パラメーター:
email_campaign_id(必須): 更新するメールキャンペーンの ID- その他のパラメーターはすべて任意で、
create-email-campaignと同じです (name、domain_id、from_local_part、from_display_name、reply_to、template_attributes、delivery_mode、delivery_options、contact_list_ids、contact_segment_ids)
delete-email-campaign
ID でメールキャンペーンを削除します。削除できるのは draft 状態のキャンペーンのみです。
パラメーター:
email_campaign_id(必須): 削除するメールキャンペーンの ID
start-email-campaign
draft 状態のメールキャンペーンの送信を直ちに開始します。開始できるのは draft 状態のキャンペーンのみです。テンプレートに body_html デザインがあり、オーディエンスと検証済みドメインが設定されている必要があります。
パラメーター:
email_campaign_id(必須): 開始するメールキャンペーンの ID
schedule-email-campaign
draft 状態のメールキャンペーンについて、将来の時刻に送信を開始するようスケジュールを設定します。スケジュールを設定できるのは draft 状態のキャンペーンのみです。
パラメーター:
email_campaign_id(必須): スケジュールを設定するメールキャンペーンの IDdatetime(必須): キャンペーンの送信日時 (ISO 8601)。未来の日時で、1 か月以内である必要があります
cancel-email-campaign
scheduled 状態のメールキャンペーンをキャンセルし、draft 状態に戻します。キャンセルできるのは scheduled 状態のキャンペーンのみです。
パラメーター:
email_campaign_id(必須): キャンセルするメールキャンペーンの ID
terminate-email-campaign
現在送信中のメールキャンペーン (started、queued、または paused) を終了し、進行中の送信を中止します。
パラメーター:
email_campaign_id(必須): 終了するメールキャンペーンの ID
reset-email-campaign
scheduled 状態のメールキャンペーンを draft 状態に戻します。リセットできるのは scheduled 状態のキャンペーンのみです。
パラメーター:
email_campaign_id(必須): リセットするメールキャンペーンの ID
get-email-campaign-stats
メールキャンペーンの集計パフォーマンス統計 (配信、開封、クリック、バウンス、迷惑メール報告、配信停止の件数と率) を取得します。
パラメーター:
email_campaign_id(必須): メールキャンペーンの IDstart_date(任意): 集計期間の開始日 (この日を含む)、YYYY-MM-DD。デフォルトはキャンペーンが最後に開始された日end_date(任意): 集計期間の終了日 (この日を含む)、YYYY-MM-DD。デフォルトは現在の日付
list-accounts
現在の API トークンでアクセスできる Mailtrap アカウントを、それぞれのアクセスレベルとともに一覧表示します。MAILTRAP_ACCOUNT_ID がなくても動作するため、アカウント ID の確認に使用してください。
パラメーター:
- パラメーターは不要です
get-billing-usage
アカウントの現在の請求サイクルにおける使用状況 (送信プランとテストプラン、上限、現在の件数) を取得します。
パラメーター:
- パラメーターは不要です
list-account-accesses
アカウントのアクセス権 (ユーザー、招待、API トークン) を一覧表示します。任意のフィルターを指定すると、特定のリソースに結果を絞り込めます。アカウント管理者またはオーナーの権限が必要です。
パラメーター:
domain_uuids(任意): ドメイン UUID で絞り込みます (文字列の配列)inbox_ids(任意): サンドボックス ID で絞り込みます (文字列の配列)project_ids(任意): サンドボックスプロジェクト ID で絞り込みます (文字列の配列)
remove-account-access
ID でアカウントアクセス権を削除します。User 指定子の場合は権限を取り消し、Invite または ApiToken 指定子の場合は指定子自体を削除します。管理者またはオーナーの権限が必要です。
パラメーター:
account_access_id(必須): 削除するアクセスレコードの ID
get-permission-resources
API トークンが管理者アクセス権を持つすべてのリソース (サンドボックス、プロジェクト、ドメイン、請求、アカウント) を、階層構造で取得します。
パラメーター:
- パラメーターは不要です
bulk-update-permissions
1 つのアカウントアクセス権に対する権限を一括作成、更新、または削除します。既存の (resource_type, resource_id) の組み合わせは更新され、新しい組み合わせは作成されます。エントリに destroy: true を設定すると、そのエントリが削除されます。
パラメーター:
account_access_id(必須): 対象のアカウントアクセス IDpermissions(必須): 権限エントリの配列。各エントリには以下が含まれます:resource_id(必須): リソース ID (数値または文字列)resource_type(必須):account、project、inbox、domain、billingのいずれかaccess_level(任意):admin/100またはviewer/10destroy(任意、ブール値): true の場合、この権限を作成または更新する代わりに削除します
list-api-tokens
アカウントのすべての API トークンを一覧表示します。
パラメーター:
- パラメーターは不要です
create-api-token
新しい API トークンを作成します。応答にはシークレットの token 値が含まれます。完全なトークンが返されるのはこのときだけなので、すぐに保存してください。紛失した場合は、トークンを再作成してください。
パラメーター:
name(必須): トークンの表示名expires_at(任意): トークンの有効期限 (ISO 8601 日時)。省略するとサーバーのデフォルト (1 年) が適用されます。有効期限のないトークンにするには、明示的にnullを指定してください。過去の日時、または 5 年を超えて先の日時は拒否されますresources(任意): トークンのアクセス範囲を限定するリソース権限の配列。各エントリには以下が含まれます:resource_type(必須):account、project、inbox、domain、billingのいずれかresource_id(必須): リソースの IDaccess_level(必須):100(管理者) または10(閲覧者)
get-api-token
ID で API トークンを取得します。メタデータのみを返します。シークレットトークンの値はここでは返されません (create-api-token / reset-api-token からのみ取得できます)。
パラメーター:
api_token_id(必須): API トークンの ID
reset-api-token
ID で API トークンをリセット (ローテーション) します。応答には新しいシークレットの token 値が含まれます。この呼び出しでのみ返されるため、すぐに保存してください。以前のトークンは無効になります。
パラメーター:
api_token_id(必須): リセットする API トークンの IDexpires_at(任意): 新しいトークンの有効期限 (ISO 8601 日時)。省略するとサーバーのデフォルト (1 年) が適用されます。有効期限のないトークンにするには、明示的にnullを指定してください。過去の日時、または 5 年を超えて先の日時は拒否されます
delete-api-token
ID で API トークンを完全に削除します。削除後、そのトークンで認証することはできません。
パラメーター:
api_token_id(必須): 削除する API トークンの ID
list-sub-accounts
組織内のサブアカウントを一覧表示します。MAILTRAP_ORGANIZATION_ID 環境変数とサブアカウント管理権限が必要です。
パラメーター:
- パラメーターは不要です
create-sub-account
組織の下に新しいサブアカウントを作成します。MAILTRAP_ORGANIZATION_ID 環境変数とサブアカウント管理権限が必要です。
パラメーター:
name(必須): 新しいサブアカウントの表示名
delete-sub-account
ID でサブアカウントを完全に削除し、そのすべてのデータを削除します。最後のサブアカウントを削除すると組織も削除されます。同じ呼び出しを繰り返すと 404 が返されます。同じサブアカウントを同時に削除しようとすると 409 が返されます。MAILTRAP_ORGANIZATION_ID 環境変数と組織管理者権限が必要です。また、組織で Organization & Sub-accounts 機能が有効になっている必要があります (無効の場合は 403)。
パラメーター:
sub_account_id(必須): 削除するサブアカウントの ID
list-inbound-folders
アカウント内のすべての受信フォルダーを一覧表示します。整形された概要を返します。
パラメーター:
- パラメーターは不要です
get-inbound-folder
ID で受信フォルダーを取得します。フォルダーの完全なレコードを JSON 形式で返します。
パラメーター:
folder_id(必須): 受信フォルダーの ID
create-inbound-folder
新しい受信フォルダーを作成します。
パラメーター:
name(必須): フォルダー名
update-inbound-folder
受信フォルダーの名前を変更します。
パラメーター:
folder_id(必須): 受信フォルダーの IDname(必須): 新しいフォルダー名
delete-inbound-folder
受信フォルダーと、その中のすべての受信トレイを完全に削除します。
パラメーター:
folder_id(必須): 受信フォルダーの ID
list-inbound-inboxes
受信フォルダー内のすべての受信トレイを一覧表示します。整形された概要を返します。
パラメーター:
folder_id(必須): 受信フォルダーの ID
get-inbound-inbox
ID で受信トレイを取得します。受信トレイの完全なレコードを JSON 形式で返します。
パラメーター:
folder_id(必須): 受信フォルダーの IDinbox_id(必須): 受信トレイの ID
create-inbound-inbox
フォルダー内に新しい受信トレイを作成します。
パラメーター:
folder_id(必須): 受信フォルダーの IDname(必須): 受信トレイ名domain_id(任意): カスタムドメイン(キャッチオール受信トレイ)に紐付けます。Mailtrap ホストの受信トレイの場合は省略します
update-inbound-inbox
受信トレイの名前を変更します。
パラメーター:
folder_id(必須): 受信フォルダーの IDinbox_id(必須): 受信トレイの IDname(必須): 新しい受信トレイ名
delete-inbound-inbox
受信トレイを完全に削除します。
パラメーター:
folder_id(必須): 受信フォルダーの IDinbox_id(必須): 受信トレイの ID
list-inbound-messages
受信トレイ内の受信メッセージを一覧表示します(カーソルによるページネーション)。結果がさらにある場合は、次のページを示すヒントを含む整形済みの概要を返します。
パラメーター:
inbox_id(必須): 受信トレイの IDlast_id(任意): 前回のレスポンスのlast_idから取得したページネーションカーソル
get-inbound-message
本文全体と添付ファイルのダウンロード URL を含む、単一の受信メッセージを取得します。メッセージレコード全体を JSON として返します。
パラメーター:
inbox_id(必須): 受信トレイの IDmessage_id(必須): メッセージの ID
delete-inbound-message
受信メッセージを完全に削除します。
パラメーター:
inbox_id(必須): 受信トレイの IDmessage_id(必須): メッセージの ID
reply-to-inbound-message
受信メッセージに返信します(元の送信者に送信)。実際のメールを送信します。アドレスには、メールアドレス文字列のみ、または { email, name? } を指定できます。
パラメーター:
inbox_id(必須): 受信トレイの IDmessage_id(必須): 返信先メッセージの IDtext/html(少なくとも一方を推奨): 返信本文from(任意): 送信者。Mailtrap ホストの受信トレイでは拒否され、カスタムドメインの受信トレイでは必須ですcc/bcc/reply_to(任意): 追加のアドレスcategory(任意): メッセージカテゴリattachments(任意):{ content (base64), filename, type?, disposition?, content_id? }の配列headers/custom_variables(任意): 文字列値を持つオブジェクト
reply-all-to-inbound-message
受信メッセージに返信し、元のメッセージの他の宛先にもコピーを送信します。実際のメールを送信します。パラメーターは reply-to-inbound-message と同じです。
パラメーター:
inbox_id(必須): 受信トレイの IDmessage_id(必須): 返信先メッセージの IDreply-to-inbound-messageと同じ任意の送信フィールドを追加
forward-inbound-message
受信メッセージを新しい宛先に転送します。実際のメールを送信します。
パラメーター:
inbox_id(必須): 受信トレイの IDmessage_id(必須): 転送するメッセージの IDto(必須): 1 件以上の宛先(メールアドレス文字列のみ、{ email, name? }、または配列)reply-to-inbound-messageと同じ任意の送信フィールドを追加
list-inbound-threads
受信トレイ内の会話スレッドを一覧表示します(カーソルによるページネーション)。必要に応じて search で絞り込めます。結果がさらにある場合は、次のページを示すヒントを含む整形済みの概要を返します。
パラメーター:
inbox_id(必須): 受信トレイの IDlast_id(任意): 前回のレスポンスのlast_idから取得したページネーションカーソルsearch(任意): スレッドの件名、およびメッセージの from/to/cc/bcc アドレスに対して、大文字と小文字を区別せずに照合するテキスト。ページネーション時には同じ値を指定します
get-inbound-thread
メッセージを埋め込んだ単一の受信スレッドを取得します(古い順)。スレッドレコード全体を JSON として返します。
パラメーター:
inbox_id(必須): 受信トレイの IDthread_id(必須): スレッドの ID
delete-inbound-thread
受信スレッドを完全に削除します。
パラメーター:
inbox_id(必須): 受信トレイの IDthread_id(必須): スレッドの ID
list-inbound-forward-rules
受信トレイの転送ルールを一覧表示します。整形済みの概要を返します。
パラメーター:
inbox_id(必須): 受信トレイの ID
get-inbound-forward-rule
ID を指定して単一の受信転送ルールを取得します。条件と宛先を含むルールレコード全体を JSON として返します。
パラメーター:
inbox_id(必須): 受信トレイの IDforward_rule_id(必須): 転送ルールの ID
create-inbound-forward-rule
受信トレイに転送ルールを作成します。すべての条件に一致する受信メッセージは、ルールの宛先に転送されます。
パラメーター:
inbox_id(必須): 受信トレイの IDname(必須): 受信トレイ内で一意のルール名conditions(任意):{ match_type, operator, value?, header_key? }の配列。match_typeはsender、recipient、またはheader、operatorはequal、not_equal、contains、starts_with、ends_with、empty、またはnot_empty(empty/not_emptyはheaderの場合のみで、valueは指定しません)。headerにはheader_keyが必須です。すべてのメッセージに一致させるには、省略するか[]を指定しますdestinations(任意): 一致したメッセージの転送先となる{ email }の配列
update-inbound-forward-rule
受信転送ルールを更新します。指定したフィールドのみが変更されます。conditions または destinations の配列を指定すると、セット全体が置き換えられます。
パラメーター:
inbox_id(必須): 受信トレイの IDforward_rule_id(必須): 転送ルールの IDname(任意): 新しいルール名conditions(任意): 条件セットの置き換え(作成時と同じ形式)。[]を指定するとすべての条件が削除され、ルールはすべてのメッセージに一致しますdestinations(任意): 宛先セットの置き換え。[]を指定するとすべての宛先が削除されます
delete-inbound-forward-rule
受信転送ルールを完全に削除します。
パラメーター:
inbox_id(必須): 受信トレイの IDforward_rule_id(必須): 転送ルールの ID
開発
- リポジトリをクローンします:
git clone https://github.com/mailtrap/mailtrap-mcp.git
cd mailtrap-mcp
- 依存関係をインストールします:
npm install
Claude Desktop または Cursor での設定
[!TIP] 設定ファイルの場所については、セットアップ セクションを参照してください。
次の設定を追加します:
{
"mcpServers": {
"mailtrap": {
"command": "node",
"args": ["/path/to/mailtrap-mcp/dist/index.js"],
"env": {
"MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
"DEFAULT_FROM_EMAIL": "your_sender@example.com",
"MAILTRAP_ACCOUNT_ID": "your_account_id",
"MAILTRAP_SANDBOX_ID": "your_sandbox_id"
}
}
}
}
Node.js の管理に asdf を使用している場合は、実行ファイルの絶対パスを指定してください:
(Mac の例)
{
"mcpServers": {
"mailtrap": {
"command": "/Users/<username>/.asdf/shims/node",
"args": ["/path/to/mailtrap-mcp/dist/index.js"],
"env": {
"PATH": "/Users/<username>/.asdf/shims:/usr/bin:/bin",
"ASDF_DIR": "/opt/homebrew/opt/asdf/libexec",
"ASDF_DATA_DIR": "/Users/<username>/.asdf",
"ASDF_NODEJS_VERSION": "22.14.0",
"MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
"DEFAULT_FROM_EMAIL": "your_sender@example.com",
"MAILTRAP_ACCOUNT_ID": "your_account_id",
"MAILTRAP_SANDBOX_ID": "your_sandbox_id"
}
}
}
}
VS Code
[!TIP] 設定ファイルの場所については、セットアップ セクションを参照してください。
{
"mcp": {
"servers": {
"mailtrap": {
"command": "node",
"args": ["/path/to/mailtrap-mcp/dist/index.js"],
"env": {
"MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
"DEFAULT_FROM_EMAIL": "your_sender@example.com",
"MAILTRAP_ACCOUNT_ID": "your_account_id",
"MAILTRAP_SANDBOX_ID": "your_sandbox_id"
}
}
}
}
}
テスト
実際の Mailtrap に対してツールを実行する
実際の Mailtrap アカウントに対してツールをエンドツーエンドで実行する方法は 2 つあります。対話的に試せるブラウザー UI の MCP Inspector、またはシェルから単発の呼び出しを行う CLI モードです。
どちらの場合も、まずバンドルをビルドする必要があります:
npm run build
また、シェルで MAILTRAP_API_TOKEN と MAILTRAP_ACCOUNT_ID をエクスポートします(mcp:cli スクリプトは両方を起動するサーバーに渡します)。
ブラウザー UI
npm run dev
Inspector は http://localhost:6274 のような URL を出力します。開いて Tools タブに切り替え、ツール(例: get-template)を選択し、パラメーターを JSON として入力して Run をクリックします。Mailtrap のレスポンスが下のパネルに表示されます。
CLI
UI を使わずに単発の呼び出しを行うには、npm run mcp:cli を使用します。npm がそのまま転送するように、Inspector の CLI フラグは -- の後に指定します:
# List all tools
npm run mcp:cli -- --method tools/list
# Call a tool — flags after the `--`
npm run mcp:cli -- \
--method tools/call \
--tool-name get-template \
--tool-arg template_id=12345
# Multiple --tool-arg flags for tools with several params
npm run mcp:cli -- \
--method tools/call \
--tool-name send-domain-setup-instructions \
--tool-arg domain_id=3938 \
--tool-arg email=devops@example.com
MCPB サーバーの実行
# Run the MCPB server directly
node dist/mcpb-server.js
# Or use the provided binary
mailtrap-mcpb-server
[!TIP] MCP Inspector を使った開発の場合:
npm run dev:mcpb
エラー処理
このサーバーでは、MCP の規約に沿った構造化エラー処理を使用します:
VALIDATION_ERROR: 入力検証エラーCONFIGURATION_ERROR: 設定の欠落または無効EXECUTION_ERROR: 実行時エラーTIMEOUT: 操作のタイムアウト(デフォルトは 30 秒)
エラーには対処方法を示すメッセージが含まれ、構造化形式でログに記録されます。
セキュリティ
- Zod スキーマによる入力検証
- 環境変数を安全に処理
- 操作のタイムアウト保護(30 秒)
- エラー出力内の機密情報をサニタイズ
ログ
INFO、WARN、ERROR、DEBUG のレベルを持つ構造化 JSON ログです。
DEBUG=true を設定するとデバッグログが有効になります。
# Example: enable debug logging
DEBUG=true node dist/mcpb-server.js
重要: サーバーはログを stderr に書き込み、stdout は JSON-RPC フレーム用に確保します。これにより、ログが混在して JSON の解析エラーが発生するのを防ぎます。
jq を使ったログ分析の例:
# Filter error logs
node dist/mcpb-server.js 2>&1 | jq 'select(.level == "error")'
# Filter debug logs
node dist/mcpb-server.js 2>&1 | jq 'select(.level == "debug")'
トラブルシューティング
よくある問題:
- API Token がない:
MAILTRAP_API_TOKENが設定されていることを確認してください - Sandbox が動作しない: ツール呼び出しで
sandbox_idを指定する(またはメッセージの送信/一覧表示/表示ツールでは従来のtest_inbox_idを指定する)か、MAILTRAP_SANDBOX_ID環境変数を設定してください - タイムアウトエラー: ネットワーク接続と Mailtrap API のステータスを確認してください
- 検証エラー: 必須フィールドがすべて指定されていることを確認してください
コントリビューション
バグ報告やプルリクエストは GitHub で歓迎しています。このプロジェクトは安全で歓迎的なコラボレーションの場を目指しており、コントリビューターには行動規範の遵守を求めます。
ライセンス
このパッケージは、MIT License の条件に基づくオープンソースとして提供されています。
行動規範
Mailtrap プロジェクトのコードベース、課題管理システム、チャットルーム、メーリングリストで活動するすべての人は、行動規範に従うことが求められます。