Invalid Emails API

無効メールリストの管理を行うことができます。

List all invalid emails [GET]

URI引数 必須 条件 説明
start_time No timestamp 無効なメールと判定された時刻の範囲をUNIXタイム形式で指定します。
Example: 1443651141
end_time No timestamp 無効なメールと判定された時刻の範囲をUNIXタイム形式で指定します。
Example: 1443651154
limit No integer 結果を取得する件数を制限します。
Example: 10
offset No integer 結果を取得する位置のオフセットを指定します。
Example: 0

Request

1
GET https://api.sendgrid.com/v3/v3/suppression/invalid_emails?start_time={start_time}&end_time={end_time}&limit=10&offset=0 HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
HTTP/1.1 200
[
  {
    "created": 1449953655,
    "email": "user1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  },
  {
    "created": 1449939373,
    "email": "user1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]

Delete invalid emails [DELETE]

複数エントリの削除
無効メールリストから削除するオプションには2種類あります:
1) "delete_all"にtrueを指定して無効メールリスト内のすべてのメールアドレスを削除する
2) "emails"に削除するメールアドレスを配列で指定して削除する

Request

1
DELETE https://api.sendgrid.com/v3/v3/suppression/invalid_emails HTTP/1.1
Request Body
1
2
3
{
  "delete_all": true
}

Response

1
HTTP/1.1 204

Request

1
DELETE https://api.sendgrid.com/v3/v3/suppression/invalid_emails HTTP/1.1
Request Body
1
2
3
4
5
6
{
  "emails": [
    "email1@test.com",
    "email2@test.com"
  ]
}

Response

1
HTTP/1.1 204

Get a specific invalid email [GET]

エントリの取得
URI引数 必須 条件 説明
email Yes string 対象メールアドレス
Example: spam1@test.com

Request

1
GET https://api.sendgrid.com/v3/v3/suppression/invalid_emails/{email} HTTP/1.1

Response

1
2
3
4
5
6
7
8
HTTP/1.1 200
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]

Delete a specific invalid email [DELETE]

エントリの削除
URI引数 必須 条件 説明
email Yes string 対象メールアドレス
Example: spam1@test.com

Request

1
DELETE https://api.sendgrid.com/v3/v3/suppression/invalid_emails/{email} HTTP/1.1

Response

1
HTTP/1.1 204