Section Tags

本機能は2020年1月13日より廃止されます。
詳細はこちらをご覧ください。

Section Tagを利用するとSMTPメッセージ内のコンテンツを置換できます。Section TagはSubstitution Tagsと構築方法は似ていますが、宛先毎ではなく、メッセージ毎に指定されます。Substitution Tagは 宛先毎 にタグと値を設定する必要がありますが、Section Tagは任意の数だけ設定することができます。Section TagはSubstitution Tagの値として使用される必要があります。 詳細は、以下の例を参照してください。

可能であればSubstitution Tagsのみを使用してください。ただし、この方法はDRYではないのと、メッセージサイズの制限を受ける場合があります。

SMTP APIのSection Tagは次のような形式です:

1
2
3
4
5
6

{
  "section": {
    ":sectionName1": "section 1 text",
    ":sectionName2": "section 2 text"
  }
}

一般的な使用方法はメール本文内にユーザごとのSubstitution Tagを参照するタグを持たせることです。このユーザタグはSection Tagへの参照を含みます。

どのようにSection Tagをフォーマットするかは、SMTP接続を生成するライブラリや、コードを記述している言語や、メールを送信する中間サーバなどに依存します。いくつかのケースでは、-subVal- が最も良い選択となる場合がありますが、 %subVal% 、 #subVal#、:subVal が良い選択となる場合があります。

%first name%といった形でSection Tag内でスペースは使用できません。

section内でSection Tagをネストすることはできません。ネストすると置換は行われません。

Section Tagsの例

SendGridに送信するメッセージ本文:

1
2
3
4
5
6
7
8
9
10
11
12

<html>
 <body>
   Hi :salutation,<br />
   Thanks so much for joining us at our event!

   <p>You have registered for the following event:<br />
    :event_details.</p>

   Thanks,<br />
   The SendGrid Team
 </body>
</html>

X-SMTPAPIのJSONヘッダの値は次のようになります:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

{
  "to": [
    "example@example.com",
    "example@example.com",
    "example@example.com"
  ],
  "sub": {
    ":salutation": [
      ":female",
      ":male",
      ":neutral"
    ],
    ":name": [
      "Alice",
      "Bob",
      "Casey"
    ],
    ":event_details": [
      ":event1",
      ":event2",
      ":event1"
    ],
    ":event_date": [
      "Jan 1",
      "Feb 14",
      "Aug 11"
    ]
  },
  "section": {
    ":male": "Mr. :name",
    ":female": "Ms. :name",
    ":neutral": ":name",
    ":event1": "New User Event on :event_date",
    ":event2": "Veteran User Appreciation on :event_date"
  }
}

Aliceが受け取るメールは以下のようになります:

1
2
3
4
5
6
7
8
9
10
11
12

<html>
 <body>
   Hi Ms. Alice,<br />
   Thanks so much for joining us at our event!

   <p>You have registered for the following event:<br />
    New User Event on Jan 1.</p>

   Thanks,<br />
   The SendGrid Team
 </body>
</html>

Bobが受け取るメールは以下のようになります:

1
2
3
4
5
6
7
8
9
10
11
12

<html>
 <body>
   Hi Mr. Bob,<br />
   Thanks so much for joining us at our event!

   <p>You have registered for the following event:<br />
    Veteran User Appreciation on Feb 14.</p>

   Thanks,<br />
   The SendGrid Team
 </body>
</html>

Caseyが受け取るメールは以下のようになります:

1
2
3
4
5
6
7
8
9
10
11
12

<html>
 <body>
   Hi Casey,<br />
   Thanks so much for joining us at our event!

   <p>You have registered for the following event:<br />
    New User Event on Aug 11.</p>

   Thanks,<br />
   The SendGrid Team
 </body>
</html>

追加のリソース