Invalid Emails

このエンドポイントでは無効メールリストの一覧取得と削除を行うことができます。

get

アドレス、応答コード指定で無効メールリストの一覧取得を行います。オプションで日付を指定することも可能です。

URI引数 必須 条件 説明
date No 1をセットします 無効メールレコードのタイムスタンプを取得します。MySQLのタイムスタンプフォーマット - YYYY-mm-dd HH:MM:SSが返ります
days No 指定する場合、正の整数 指定した過去の日数無効メールリストを取得します(今日を含みます)
start_date No YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 無効メールリストを取得する期間の開始日を指定します
end_date No YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 無効メールリストを取得する期間の終了日を指定します
limit No 整数 応答結果で取得するリスト数の上限を指定します
offset No 整数 一覧取得するリストの初期位置を指定します
email No メールアドレス(例:testing@example.com) 検索するメールアドレス
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/invalidemails.get.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12
[
  {
    "reason": "Known bad domain",
    "created": "2011-06-06 16:11:57",
    "email": "test@example.com"
  },
  {
    "reason": "Invalid address",
    "created": "2012-08-17 11:04:38",
    "email": "brandon"
  }
]

Call

GET https://api.sendgrid.com/api/invalidemails.get.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12
<invalidemails>
   <invalidemail>
      <reason>Known bad domain</reason>
      <created>2011-06-06 16:11:57</created>
      <email>test@example.com</email>
   </invalidemail>
   <invalidemail>
      <reason>Invalid address</reason>
      <created>2012-08-17 11:04:38</created>
      <email>brandon</email>
   </invalidemail>
</invalidemails>

count

無効メールの数を取得します。

URI引数 必須 条件 説明
start_date No YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 無効メール数をカウントする期間の開始日を指定します
end_date No YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 無効メール数をカウントする期間の終了日を指定します
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/invalidemails.count.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "count": 2
}

Call

GET https://api.sendgrid.com/api/invalidemails.count.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
<result>
   <count>2</count>
   <result> </result>
</result>

delete

無効メールリストからアドレスを削除します。

URI引数 必須 条件 説明
email Yes 有効なユーザアカウントのメールアドレスである必要があります 無効メールリストから削除するメール
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/invalidemails.delete.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/invalidemails.delete.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com

Response

1
2
3
4
<result>
   success
   <result> </result>
</result>