Subuser Invalid Emails

このエンドポイントを含むWeb API v2の機能は、2025年2月に提供を終了します。

今後はWeb API v3をご利用ください。

Retrieve Invalid Emails

URI引数 必須 条件 説明
task Yes getを指定します 指定したサブユーザの無効メールリストを取得することができます
user Yes 親アカウント配下に登録されているサブユーザ 無効メールリストを取得するサブユーザ
date No 0 または 1 ISO-8601フォーマットでタイムスタンプを取得する場合の任意の引数です。Pacific Timezoneで取得できます。フォーマット: YYYY-MM-DD HH:MM:SS
Parameter Value Requirements Description
1
3501393288

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=get&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
  {
    "email": "example@example.comm",
    "reason": "Mail domain mentioned in email address is unknown",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "isaac@hotmail",
    "reason": "Bad Syntax",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "example@example.com",
    "reason": "Known bad domain",
    "created": "2009-06-01 19:41:39"
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=get&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<invalidemails>
   <invalidemail>
      <email>example@example.comm</email>
      <reason>Mail domain mentioned in email address is unknown</reason>
      <created>2009-06-10 12:40:30</created>
   </invalidemail>
   <invalidemail>
      <email>isaac@hotmail</email>
      <reason>Bad Syntax</reason>
      <created>2009-06-10 12:40:30</created>
   </invalidemail>
   <invalidemail>
      <email>example@example.com</email>
      <reason>Known bad domain</reason>
      <created>2009-06-10 12:40:30</created>
   </invalidemail>
</invalidemails>

Delete Invalid Emails

SendGridは無効なメールをドロップします。ユーザはそのアドレスが有効だと認識できれば、無効メールリストをいつでも削除することができます。

URI引数 必須 条件 説明
task Yes deleteを指定します 指定したサブユーザの無効メールリストを削除することができます
user Yes 親アカウント配下に登録されているサブユーザ 無効メールリストを削除するサブユーザ
email Yes 文字列 削除する無効メールを指定する必要があります
Parameter Value Requirements Description
1
6482196405

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=delete&email=invalidemail@example.com

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=delete&email=invalidemail@example.com

Response

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