mcpField
U
using-email-templates

using-email-templates

github.com/mailtrap開発1153 回インストール今日更新
リポジトリ

using-email-templates について

using-email-templates は、Mailtrap がホストするメールテンプレートの統合とテストを支援するスキルです。UUID によるテンプレート指定、Handlebars 変数、送信ストリーム、最新の SDK と API ドキュメントの参照を扱います。

主な機能

  1. 01テンプレート UUID とペイロードの指針
  2. 02Handlebars の変数と構文
  3. 03トランザクション／一括送信ストリームの説明
  4. 04テンプレートの UI と API 管理
  5. 05サンドボックスでのプレビュー指針

活用シーン

  1. 01Mailtrap テンプレートを使ったメール送信
  2. 02UI でのテンプレート作成や編集
  3. 03Templates API によるテンプレートの登録
  4. 04Handlebars メールコンテンツの作成やテスト

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/mailtrap/mailtrap-skills --skill using-email-templates

インストール後、Claude Code で/using-email-templatesを入力して読み込まれたか確認します。

詳細

Mailtrap のメールテンプレートを使用する

概要

テンプレートは Mailtrap の UI で編集し、アプリから UUID を参照して、送信時に Handlebars のデータを差し込みます。同じテンプレートを トランザクション と バルク（プロモーション） の両方のストリームで使用できます。連携時にストリームを選択してください。

SDK コードを生成する前に： 現在のメソッドシグネチャを確認するため、以下にリンクされている該当 SDK リポジトリの README を読んでください。記憶に頼らないでください。

API リクエストボディを生成する前に： 以下の公式ドキュメントとサンプルを使用してください。リクエストの形式は API リファレンスで確認するものであり、推測してはいけません（AI 支援コーディングを使用する場合も同様です）。

API によるテンプレート管理（UI の外部での作成／更新／一覧表示）：Templates API。

関連スキル： authorizing-api-requests（トークン、環境変数、認証ヘッダー）、sending-emails（ベース URL とストリーム）、testing-with-sandbox（実際に配信せずにプレビュー送信）。

使用する場面

  • Mailtrap がホストするテンプレートを使用してメールを送信またはテストする場合（送信ペイロード内の UUID）
  • UI でテンプレートを作成または編集する場合
  • Templates API を使ったテンプレートの CRUD（自動化、プロビジョニング）
  • template_uuid と template_variables を使用する API ボディ
  • Handlebars の条件分岐、ループ、エスケープあり／なしの HTML

クイックリファレンス

API 操作

開発者向けドキュメントで、以下を開いてください。

リクエストボディの形式は通常、インタラクティブリファレンス内の EmailFromTemplate です。

認証

該当するストリームのホスト（send.api.mailtrap.io または bulk.api.mailtrap.io）に対して、Authorization: Bearer $MAILTRAP_API_TOKEN を指定して送信します。トークンのスコープ、保存方法、代替の Api-Token ヘッダーについては、スキル authorizing-api-requests を参照してください。

例（curl）— テンプレート送信
curl -X POST https://send.api.mailtrap.io/api/send \
  -H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": {"email": "[email protected]", "name": "Your App"},
    "to": [{"email": "[email protected]"}],
    "template_uuid": "your-uuid",
    "template_variables": {"user_name": "Jane"}
  }'
ペイロードの形式

リテラルの text／html をテンプレート用フィールドに置き換えます。たとえば、次のとおりです。

  • template_uuid（テンプレートの Integration タブに記載）
  • template_variables（キーが Handlebars 変数と一致するオブジェクト）

必須フィールド（例：from、to）の正確な指定方法は、そのストリームでテンプレートを使用しない送信を行う場合と同じルールに従います。

Handlebars（サポートされるパターン）
  • {{name}} — エスケープされた出力。{{{html}}} — 生の HTML
  • {{#if}}／{{#unless}}、{{#each}}、{{#with}}
  • {{order.id}} のようなネストされたパス
  • ブロックの出力を抑制する偽値には、空文字列、0、false、空のコレクションなどがあります（製品ドキュメントを参照）

構文と例の全文：Using Handlebars with Email Templates。テストのワークフロー：Testing templates with Handlebars。Sandbox のプレビュー送信：Send test emails (sandbox)。

テンプレートの保存場所

アプリのサイドバーにある Templates。UUID とストリーム固有の連携スニペットは、各テンプレートの Integration タブにあります。

テンプレート HTML の生成

ユーザーが新しいテンプレートを作成している場合は、依頼されるのを待たずに、テンプレート HTML の生成を積極的に提案してください。出力は任意の Web HTML ではなく、実際の メールテンプレート でなければなりません。また、モバイルに対応（レスポンシブで、さまざまなメールクライアントや画面サイズで適切に表示されること）している必要があります。

SDK

よくある間違い

間違い修正
template_uuidとtext／htmlを併用するテンプレート送信では、APIスキーマに従ってテンプレートフィールドを使用します
リスクのある変更でサンドボックスを使わないサンドボックス送信／Testing APIでプレビューします（testing-with-sandboxおよびテストメールの送信を参照）

コメント

Markdown 対応