要素settings内のoptionについて説明します。
配信速度や、配信エンジンの設定を指定可能なオプションです。
"tc_option":{
"stop_send":{"timemin":"hh:mm+09:00","timemax":"hh:mm+09:00"},
"lifetime":3600,
"retry_interval":60
}
- 設定値の組み合わせによっては、正しく配信されない可能性もありますので、ご利用には十分にご注意ください。
配信予約処理、settingsについては、こちらをご参照ください。
もくじ
構成
optionは、3つの要素で構成されます。
- stop_send
- lifetime
- retry_interval
stop_send
深夜の時間帯など配信を禁止する時間帯を設定できます。
配信禁止設定をした時間帯は配信を停止し、配信禁止時間帯が過ぎると配信を再開します。
"stop_send":{"timemin":"hh:mm+09:00","timemax":"hh:mm+09:00"}
配信禁止時間帯においても、配信エンジンへの配信指示は実施されます。
timemin/timemax
配信停止を開始する時間(timemin)、配信を再開する時間(timemax)指定します。
- 設定可能な範囲は、00:00〜23:59(24時間表記)
- hh:mm形式で指定
- timeminとtimemaxの設定ミスに注意してください。
例) timemin=22:10 timemax=22:00とすると、当日の22:10から、翌日の22:00まで配信が停止されてしまいます。
lifetime
データ生存時間(lifetime)は、配信エンジンが送信用のデータを受け付けてから、データを保持する期間となります。
"lifetime":3600
リトライ可能なエラーとなった場合に、データ生存している間、配信のリトライを実施します。
弊社の配信エンジンは、宛先毎に配信データを保持しています。
- 設定時間単位は秒
- 設定可能な範囲は、3,600秒(1時間)〜86,400秒(24時間)まで
retry_interval
送信先メールサーバーがリトライ可能な応答を返却したときの、リトライする間隔を設定できます。
"retry_interval":60
- 設定時間単位は秒
- 設定可能な時間は60秒(1分)〜1,800秒(30分)
配信禁止時間帯とリトライ間隔と生存時間の関係
配信禁止時間帯中のデータ生存時間
データ生存時間(lifetime)は、配信禁止期間を考慮した値を設定してください。
配信禁止時間帯中も、配信エンジンへのデータ送付とデータ生存時間(lifetime)の消化は進みます。
生存時間が配信禁止時間帯中に終わってしまう設定の場合、対象の配信は配信エラーとなります。
エラー内容については、SMTP応答コード一覧をご確認ください。
データ生存時間とリトライ間隔と配信禁止時間帯
リトライ間隔(retry)は、データ生存時間(lifetime)を考慮した値を設定する必要があります。
例として、
データ生存時間(lifetime)の最小値は1時間で、リトライ間隔(retry)の最大値は30分とした場合、配信失敗後、1回のリトライは可能ですが2回目以降は実施されない可能性があります。
また、配信失敗後に配信禁止時間帯に入りますと、リトライは禁止時間帯の終了までおこなわれず、その間に生存時間が終了してしまうと、リトライが実施されず、エラーとなります。