送信先ごとにメールの文面を変える差し込みメールを送信する

Web API 技術情報

メールマガジンなどでより効果の大きいメールを送るならば検討したいのが差し込みメールです。名前や商品、リンク先のURLをパーソナライズすることで、より相手に最適化されたメールを送信できるようになります。

一般的にはシステム側でメールの文面を最適化してメールサーバに送りますが、Customers Mail Cloudには元々差し込みメール機能が用意されています。今回はこの機能の使い方を解説します。

前提条件

  • この機能はAPI経由でのみ利用できます
  • Proプランの契約が必要です

APIのエンドポイント

APIのエンドポイントは次のようになります。 SUBDOMAIN は契約毎に異なるので注意してください。最後の拡張子はJSONまたはXMLが指定でき、それぞれレスポンスフォーマットが異なります。

POST https://SUBDOMAIN.smtps.jp/api/v2/api/v2/emails/bulk.[json|xml]

以下はデータフォーマットをJSONとして実行した際の内容です。

データの指定

差し替えるデータは to にて指定します。

{
  :,
  "to" : [
    {
      "name" : "Personal Name1",
      "address" : "user1@example.com",
      "item1": "アイテム1"
    },
    {
      "name" : "Personal Name2",
      "address" : "user2@example.com",
      "item1": "アイテム2"
    }
  ],
  :
}

このように to 以下を配列で指定します。nameおよびaddressは必須です。他は自由にキーと値を決められます。

テンプレート

文字列の差し替えは以下のキーで指定できます。

  • subject
    件名
  • text
    本文（テキスト）
  • html
    本文（HTML）
  • headers
    ヘッダー

そして差し替え部分は ((#name#)) のように ((#キー名#)) という記法を使います。例えば subject（件名）で ((#name#))様だけの特別セール！ とした場合には、 Personal Name1様だけの特別セール！ といった文字に差し替わります。

headers（ヘッダー）の場合は次のように指定します。

[
  {
    "name" : "X-Api-Data",
    "value" : "((#customer-id#))"
  }
]

ここで指定したデータはBouncesやDeliveriesで取得可能です。

注意点

このAPIではtoは個別配信として送信されます。toで指定できる宛先の数は1,000までとなります。1,000を超えて配信する場合にはAPIを複数回呼び出してください。

まとめ

メールを個別配信として、本文を差し替えたいという要望はよくあります。別途システムを開発することもできますが、Customers Mail Cloudであれば、開発の必要がありません。ぜひご利用ください。