エラーフィルター

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

概要

指定されたメールアドレスがエラーフィルターに登録されている場合に、登録されている情報を取得します。

補足説明
エラーコードによるエラーカウントの加算値については、SMTP応対コード一覧の「カウント」欄を確認してください。

SMTP応答コード一覧

注意事項
一度のリクエストで指定可能なアドレスは最大10,000件までです。

メソッドとURL

メソッド URL
POST https://{HOST名}/errorfilter

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
items Object Array ◯ 取得用データのリスト。以下の項目を複数設定することで、複数のメールアドレスの情報を取得可能。
address String ◯ エラーカウントを確認するメールアドレス。

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
413 Request Entity Too Large 指定したアドレスの件数が、所定値を超えている。
500 Internal Server Error 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

ボディパラメーター

項目 型 説明
items Object Array レスポンスのリスト。配列で結果が格納される。
※指定したアドレスがエラーフィルターに未登録の場合、そのアドレスのデータは items 配列に含まれません。
※複数アドレスを指定した場合、レスポンスに含まれないアドレスは未登録であることを示します（未登録であってもレスポンスは200の正常応答となります）。
address String エラーフィルターに登録されているメールアドレス。
count Number エラーカウント。小数点第1位まで表示。
registered_date String 初回登録日時。
update_date String 最終更新日時。
count Number items配列に含まれるオブジェクト（返却された登録済アドレス）の件数。
アドレスごとのcountとは用途が異なる。
message String 失敗時に設定される補足メッセージ

サンプル

リクエスト

{
  "items":[
    {
      "address":"aaa@example.com"
    },
    {
      "address":"bbb@example.com"
    }
  ]
}

レスポンス

正常

{
  "items": [
    {
      "address": "aaa@example.com",
      "count": 1,
      "registered_date": "yyyy-mm-ddThh:mm+09:00",
      "update_date": "yyyy-mm-ddThh:mm+09:00"
    }
  ]
  "count": 1
}

エラー

{
 "message": "Too Many Requests"
}

補足情報が返却されます。