settings(配信予約)

settings(配信予約)

要素delivery内のsettingsについて説明します。

"settings":{
  "send_time":"yyyy-mm-ddThh:mm+09:00",
  "request_id":"xxxxxxxxxxxxxxxxxxxxxxxxx",
  "from":{
    "name":"from表示名",
    "address":"xxxxxxx@xxx.xx"
  },
  "reply_to":{
    "address":"xxxxxxx@xxx.xx"
  },
  "tc_option":{....
  },
  "throttle":300,
  "error_count":0,
  "ignore_attachments_size":false
}

配信予約処理、deliveryについては、こちらをご参照ください。

配信予約

delivery(配信予約)

構成

settingsは、8つの要素で構成されます。

構成要素
  1. send_time
  2. request_id
  3. from
  4. reply_to
  5. tc_option
  6. throttle
  7. error_count
  8. ignore_attachments_size

send_time

配信予定時間を指定します。

"send_time":"yyyy-mm-ddThh:mm+09:00"

予約配信

配信予定の日時を指定します。分単位で指定できます。

注意事項

以下の場合はエラーとなりますのでご注意ください。

  1. 存在しない日時
    例)2020-02-30T11:00+09:00 など
  2. リクエストを受け付けたタイミングより過去の時刻。
    直近の時刻を指定する場合には、即時配信をご利用ください。
  3. リクエストを受け付けた時刻より32日以上の未来日。

即時配信

nowを日時の代わりに指定します。(半角英小文字)

"send_time":"now"

予約完了後、引き続き配信処理を実施します。

補足説明

「now」で配信をおこなった場合、配信データの作成を開始した時刻を配信時刻として登録します。

request_id

リクエストを一意に判別するための要素です。お客様側で任意の値を指定できます。

"request_id":"xxxxxxxxxxxxxxxxxxxxxxxxx"
注意事項

  • 指定可能な文字は、半角英数小文字、64桁以下です。
  • 過去に利用したIDは使用できません。

request_idの利用方法は、こちらをご参照ください。

from

ヘッダfromに設定する値を指定します。

"from":{
  "name":"from表示名",
  "address":"xxxxxxx@xxx.xx"
}

name

ヘッダfromに表示される文字列を設定します。メーラーなどで差出人の名前として利用されます。

address

ヘッダfromに表示されるemailアドレスを設定します。

注意事項

from要素に指定可能なメールアドレスは、以下の条件を満たす必要があります。

  1. 250Byte以下
  2. (半角英文字・数字が1文字以上)@(半角英文字・数字が1文字以上)のフォーマット
  3. from要素に指定可能なデータは、以下の合計が254Byte以下
    name要素の文字列 + 半角スペース + 「<」カッコ + address要素の文字列 + 「>」カッコ

reply_to

返信先情報を指定します。

"reply_to":{
  "address":"xxxxxxx@xxx.xx"
 }

address

メールを受信したエンドユーザーが返信する際、fromで設定したメールアドレスとは異なるメールアドレスを返信先として、指定することができます。

注意事項

  1. reply-toヘッダを有効としないメーラーが存在しますのでご注意ください。(docomoは基本的にご利用できません)
  2. メールアドレスは256Byte以下。

tc_option

配信エンジンのオプションを指定します。
詳細は以下をご参照ください。

tc_option(配信予約)

throttle

分間あたりに送信されるメール通数を制御します。

"throttle":60
補足説明
添付ファイル機能を利用している場合、ファイルサイズによる配信速度の制御があります。その場合、より小さい値の配信速度で送信されます。
注意事項

  • 1分間の送信通数(通/分)で指定します。
  • 設定可能な値は60通/分〜10,000通/分。

error_count

送信したメールがエラーとなった場合、エラーメールの受信結果によりメールアドレス単位でエラーをカウントし、フィルタリングをおこないます。

"error_count":0

指定されたエラー回数を超えるメールアドレスを、配信対象外とします。
1を指定した場合は、エラー回数が2回以上のメールアドレスが配信対象から除外されます。

注意事項

  • 設定可能な値は0回〜2回。
補足説明
未指定の場合、0回が指定されたものとして動作します。

メールアドレス単位のエラー回数の確認方法はこちらをご参照ください。

エラーフィルター登録情報取得

ignore_attachments_size

添付ファイルの総ファイルサイズチェック処理を制御します。
trueが指定されている場合、総ファイルサイズの上限値である2MByteよりも大きなサイズのファイルを設定可能です。
※リクエストサイズ6MByteまで

"ignore_attachments_size":true
補足説明
一部キャリアドメインでは受信可能なファイルサイズが2MByteまでとなっているため、総ファイルサイズの上限値を2MByteまでとしております。
その他のドメイン宛に2MByteよりも大きなサイズのファイルを送信したい場合は、本設定をtrueにしてください。

request_idの利用方法

多重配信抑止

ネットワークの瞬断などが発生した場合、request_idが指定されていると、以下のような制御が可能です。

  1. ネットワークの瞬断などで応答が受け取れない場合、同一のリクエストを実施する。
  2. リクエストを受け付けていなければ、予約処理が実施される。
  3. 既にリクエストを受け付けていれば、エラーとなる。

配信IDの確認

ネットワークの瞬断などが発生して配信IDが取得できなかった場合、request_idで配信情報を取得し、配信IDを取得することが可能です。

配信ステータス取得