メール配信設定更新

メール配信における動作設定を行うことができる。

設定できる項目は下記。最低一つの項目を更新する必要がある。

  • 再送上限回数(defer_limit)

リクエスト

エンドポイント

/v1/settings/mails

HTTPメソッド

POST

リクエストボディ

JSON形式であること

要素名
要素数
制限
説明
defer_limit 数値 1

0から20までの整数値

再送試行を行う上限回数
リクエストボディ サンプル

{
  "defer_limit": 10
}

レスポンス

ステータスコード
状態
コード
成功 200
リクエストボディがjsonではない 400
jsonリクエストのバリデーションエラー 400
認証失敗 401
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
成功

{
  "code":200,
  "data":[
    {"defer_limit":10}
  ]
}

失敗

{"code":400,"validation_errors":{"defer_limit":"must be 0 times or more. current -1"}}

{"code":400,"validation_errors":{"defer_limit":"must be 20 times or less. current 21"}}

{"code":400,"data_error":{"data":"invalid format"}}

{"code":400,"validation_errors":{"any_defined_parameters":"required"}}

設定に関する説明

下記の説明を確認、理解した上で設定を変更すること。
デフォルト値を推奨値としており、利用者のユースケースに応じた変更を許可するものである。

再送上限回数

メールの送信において、宛先メールサーバの状況や宛先メールボックスの容量超過等、一時的なエラーによって配送が行えないケースが存在する。
一時的な配送エラーが起きた場合、@utobahn MTA は一定の間隔を空けた上で再送試行を行う。再送回数の上限に達した場合、そのメールはバウンスとして扱う。

デフォルト値は20回で、再送間隔を広げながらおよそ1週間かけて行う。
再送回数と再送間隔の関係の目安は下記の表の通り。ただし、実際の再送間隔はサーバ状況等により左右されることがある。
本設定の値を小さくした場合、本来配送可能なメールが配送できなくなるリスクについて留意すること。

再送回数
再送までの時間
初回配送試行後の経過時間
1回目 1分 1分
2回目 4分 5分
3回目 5分 10分
4回目 10分 20分
5回目 10分 30分
6回目 30分 1時間
7回目 1時間 2時間
8回目 1時間 3時間
9回目 1時間 4時間
10回目 1時間 5時間
11回目 1時間 6時間
12回目 6時間 12時間
13回目 6時間 18時間
14回目 6時間 1日
15回目 1日 2日
16回目 1日 3日
17回目 1日 4日
18回目 1日 5日
19回目 1日 6日
20回目 1日 7日