getMail
- 印刷する
- PDF
getMail
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Email送信リクエストの詳細を照会
送信リクエストのあったリストを照会します。
GET https://{endpoint}/mails/{mailId}
リクエスト
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| mailId | Yes | String | Email ID (それぞれのメール1件を区別するID) |
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | 認証失敗、間違ったリクエスト |
| 500 | サーバエラー |
例示
リクエスト
GET https://mail.apigw.ntruss.com/api/v1/mails/20181120000000011009
レスポンス
{
"requestId":"20181120000000010999",
"requesterIp":"10.78.xx.73",
"requestDate":{
"utc":1542694793240,
"formattedDate":"2018-11-20",
"formattedDateTime":"2018-11-20 15:19:53 240"
},
"mailId":"20181120000000011009",
"title":"test!",
"templateSid":41,
"templateName":"test2",
"emailStatus":{
"label":"一部失敗",
"code":"PF"
},
"senderAddress":"a@ac.om",
"senderName":null,
"sendDate":{
"utc":1542694793856,
"formattedDate":"2018-11-20",
"formattedDateTime":"2018-11-20 15:19:53 856"
},
"reservationDate":null,
"body":"<body>...</body>",
"referencesHeader":null,
"attachFiles":[
],
"recipients":[
{
"address":"test123456789@ncp-mail.com",
"name":"",
"type":{
"label":"受信者",
"code":"R"
},
"received":false,
"receivedDate":null,
"status":{
"label":"送信失敗",
"code":"F"
},
"retryCount":0,
"sendResultMessage":"550 5.1.1 No such user 3vir-yOYtA9fRTlWpjkR3 - nsmtp\n",
"sendResultCode":"RECIPIENT_ADDRESS_ERROR",
"sendResultCodeMessage":"受信者のアドレスエラーにより、送信に失敗しました."
},
{
"address":"test12@ncp-mail.com",
"name":"",
"type":{
"label":"受信者",
"code":"R"
},
"received":false,
"receivedDate":null,
"status":{
"label":"送信成功",
"code":"S"
},
"retryCount":0,
"sendResultMessage":"Mail sent.",
"sendResultCode":"MAIL_SENT",
"sendResultCodeMessage":"メールを送信しました."
}
],
"advertising":false
}
属性
| 項目 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| requestId | Yes | String | Email送信リクエストのID(それぞれのリクエストを区別するID、一括で複数件のメール送信を要請する場合、requestIdが複数のmailIdを含むことがある。 | |
| mailId | Yes | String | Email ID (それぞれメール1件を区別するID) | |
| requesterIp | Yes | String | Email送信要請者のIP | |
| title | Yes | String | メールのタイトル | |
| body | Yes | String | メールの内容 | |
| templateSid | No | Integer | テンプレートID | |
| templateName | No | String | テンプレート名 | |
| senderAddress | Yes | String | 送信者のEmailアドレス | |
| senderName | No | String | 送信者の名前 | |
| emailStatus | Yes | Status | 送信のステータス | |
| requestDate | Yes | NesDateTime | リクエストの日時 | |
| sendDate | No | NesDateTime | 送信完了の日時 | |
| reservationDate | No | NesDateTime | 予約日時 | |
| advertising | Yes | Boolean | 広告メールの可否 | |
| referencesHeader | No | String | Referencesヘッダー(次の形になる必要がある。<unique_id@domain.com>)、NAVERメールではReferencesヘッダーごとにメールをまとめて確認することができる。特定メールを集めて照会するには、Uniqueな値が入力される必要がある。値が重複する場合は、同じメールスレッドと反代位してメールをまとめて表示する。１つだけ値を入力しても可能(Referencesヘッダーの最上段の値だけで判断)。 | |
| attachFiles | No | List<AttachFile> | 添付ファイルのリスト | |
| recipients | Yes | List<Recipient> | 受信者のリスト |
エラーコード
| HTTP Status Code | リターンコード | レスポンスメッセージ |
|---|---|---|
| 400 | 77101 | ログイン情報のエラー |
| 400 | 77102 | BAD_REQUEST |
| 400 | 77103 | リソースが存在しない |
| 403 | 77201 | 権限なし |
| 403 | 77202 | Email商品の利用申込をしていない |
| 405 | 77001 | METHOD_NOT_ALLOWED |
| 415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
| 500 | 77301 | 基本プロジェクトが存在しない |
| 500 | 77302 | 外部システムAPIの連動エラー |
| 500 | 77303 | その他のINTERNAL_SERVER_ERROR |
この記事は役に立ちましたか?