Settings (Filters)

以下はX-SMTPAPIヘッダのFiltersセクションで指定可能な設定です。全てのFilterと設定名は小文字で指定する必要があります。

  • 設定を有効化する場合、もしくはSMTPAPIからフィルタを呼んだ場合、その設定に関する全てのパラメータを指定する必要があります。
  • 設定を有効化した際の設定値のデフォルトは、X-SMTPAPIヘッダで指定した場合を除きWebサイト上で設定した値になります。
  • 無効化されていた設定を有効化した場合、無効化されていた際の設定を引き継ぎません。X-SMTPAPIヘッダで値を設定する必要があります。
    :あるデザインが設定されているFooterが無効化されている場合、APIで有効化するだけでは元の設定に戻りません。 APIでFooterにデザインを設定し直す必要があります。
  • 全てのフィルタ名と設定名は小文字で指定する必要があります。

各設定の詳細についてはSettingsを参照してください。

いくつかの設定はこのページには掲載されていません。このページに掲載されていない設定はメール単位で変更できません。 それらの設定変更を行う場合、Web API Filter Settingsを参照してください。

Filter: bcc

指定したアドレスに対してBCCコピーを送信します。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
email email bccの送信先アドレス
1
2
3
4
5
6
7
8
9
10
{
  "filters" : {
    "bcc" : {
      "settings" : {
        "enable" : 1,
        "email" : "you@example.com"
      }
    }
  }
}

Filter: bypass_list_management

本機能は非常に強力です。このため、送信メッセージ単位でのみ利用可能です。十分注意して利用してください。

メールには通常の管理上非常に重要なものがあります。パスワードリセットや緊急警報などです。 このフィルタを有効にすることにより通常の配信停止リスト / バウンスリスト / 迷惑メール報告リストのチェックをバイパスし、メールを送信します。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
1
2
3
4
5
6
7
8
9
{
  "filters" : {
    "bypass_list_management" : {
      "settings" : {
        "enable" : 1
      }
    }
  }
}

Filter: clicktrack

メールのテキストおよびHTML本文内のリンクをSendGridのWebサーバを経由するよう書き換えることにより、 リンクがクリックされたことをトラッキングすることを可能にします。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化

1
2
3
4
5
6
7
8
9
{
  "filters" : {
    "clicktrack" : {
      "settings" : {
        "enable" : 1
      }
    }
  }
}

Filter: dkim

DKIM認証でメッセージを署名するドメインを指定します。 このドメインはメールのFromアドレスのドメインと一致している必要があります。

パラメータ名 パラメータ値 パラメータ説明
domain domain DKIM認証で署名に使用するドメイン名
use_from 0 | 1 有効化された場合、From:ヘッダのドメインがDKIM署名として使用されます。

1
2
3
4
5
6
7
8
9
10
{
  "filters" : {
    "dkim" : {
      "settings" : {
        "domain" : "example.com",
        "use_from" : false
      }
    }
  }
}

Filter: footer

メールのテキストまたはHTML本文の下部にフッタを挿入します。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
text/html string HTML本文
text/plain string テキスト本文

1
2
3
4
5
6
7
8
9
10
11
{
  "filters" : {
    "footer" : {
      "settings" : {
        "enable" : 1,
        "text/html" : "<p>Thanks,<br />The SendGrid Team<p>",
        "text/plain" : "Thanks,\n The SendGrid Team"
      }
    }
  }
}

Filter: ganalytics

Google Analyticsと連携するためにリンクを書き換えます。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
utm_source string utm_sourceフィールドの値
utm_medium string utm_mediumフィールドの値
utm_term string the utm_termフィールドの値
utm_content string utm_contentフィールドの値
utm_campaign string utm_campaignフィールドの値

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "filters" : {
    "ganalytics" : {
      "settings" : {
        "enable" : 1,
        "utm_source" : "Transactional Email",
        "utm_medium" : "email",
        "utm_content" : "Reset Your Password",
        "utm_campaign" : "Redesigned Transactional Messaging"
      }
    }
  }
}

Filter: opentrack

‘replace’を使用しない場合、メールがオープンされたことをトラッッキングするために<img>タグをHTMLセクションの下部に挿入します。’replace’を使用した場合、トラッキング用の画像を任意の場所に挿入することができます。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
replace string 送信時にSendGridによりトラッキング用画像に置換される文字列

1
2
3
4
5
6
7
8
9
10
{
  "filters" : {
    "opentrack" : {
      "settings" : {
        "enable" : 1,
        "replace" : "%opentrack%"
      }
    }
  }
}

Filter: spamcheck

SpamAssassinによりメッセージが迷惑メール判定されるかテストして判定されたらドロップします。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
maxscore 110.0 スコアを獲得したらドロップします。 (デフォルトは5.0です。値を高くすると迷惑メールに判定される可能性が高まります)
url url レポートのコピーをPOSTするURL(任意)。 Spam Checkerについてはこちらを参照してください。

1
2
3
4
5
6
7
8
9
10
11
{
  "filters" : {
    "spamcheck" : {
      "settings" : {
        "enable" : 1,
        "maxscore" : 3.5,
        "url" : "http://example.com/compliance"
      }
    }
  }
}

Filter: subscriptiontrack

配信管理のためのリンクをテキストおよびHTML本文の下部に挿入、もしくはメールの任意の場所にリンクを挿入します。

配信停止のためのリンクをメールの末尾に追加する場合、text/htmltext/plainを使用してください。 タグ(例えば[unsubscribe]など)をリンクで置き換えたい場合は、replace パラメータを使用してください。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
text/html string 配信停止のリンクを含むHTMLがメールの末尾に追加されます。以下のような形でタグを含めてください。 配信停止は<% こちら %>
text/plain string 配信適しのリンクを含むテキストがメールの末尾に追加されます。以下のようなタグを含めてください。 配信停止はこちら:<% %>
replace string 配信停止URLに置換されるタグです(例:[unsubscribe_url])。 このパラメータが含まれていた場合、text/htmltext/plainのURLを上書きします。 タグはHTMLやその他のフォーマットなしで、リンクのURLで置換されます。

landing引数はSMTP APIでは使用することはできません。この引数はWebダッシュボードまたはWeb APIからのみ使用することができます。 また、アカウントレベルの設定になります。

1
2
3
4
5
6
7
8
9
10
11
{
    "filters": {
        "subscriptiontrack": {
            "settings": {
                "text/html": "If you would like to unsubscribe and stop receiving these emails <% click here %>.",
                "text/plain": "If you would like to unsubscribe and stop receiving these emails click here: <% %>.",
                "enable": 1
            }
        }
    }
}

Filter: templates

これはTransactional Templateの設定です。 SendGridは複数テンプレートや複数バージョンのテンプレートをサポートします。以前Template Appと呼ばれていたAppは現在、 Legacy Template Appと呼ばれています。

メール送信の際に Transactional Templateにより作成されたテンプレートを使用します。 SMTPAPIでのTransactoinal Templateの使用方法については Transactional Templates API Referenceを参照してください。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
template_id string メール送信の際に使用するテンプレートID

1
2
3
4
5
6
7
8
9
10
{
  "filters": {
    "templates": {
      "settings": {
        "enable": 1,
        "template_id": "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f"
      }
    }
  }
}

Filter: template

この設定は元々Email Template Appと呼ばれていたものです。現在、より機能の充実したTransactional Template(Filter: templates)があります。 Transactional Templateはバージョン管理やその他いくつかの機能をサポートしています。

メールコンテンツをテンプレートにラップします。マーケティングメールやフォーマットされたメッセージの送信時に有効です。

パラメータ名 パラメータ値 パラメータ説明
enable 0 | 1 この設定の有効化または無効化
text/html string テンプレートのHTMLコンテンツを含む文字列(<% body %>タグを含む必要があります)

1
2
3
4
5
6
7
8
9
10
{
  "filters" : {
    "template" : {
      "settings" : {
        "enable" : 1,
        "text/html" : "<html><head></head><body bgcolor='pink'><div style='width:200px' bgcolor='#FFF'><% body %></div></body></html>"
      }
    }
  }
}