getMail

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

送信リクエストしたメールリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/mails/{mailId}

リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`mailId`	String	Required	メール識別用の固有 ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/mails/20181120000000010999'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`requestId`	String	Required	リクエスト識別のためのメール送信リクエスト ID 一度に複数件のメール送信をリクエストする場合、`requestId`は複数の`mailId`を含むことができる
`requesterIp`	String	Required	メール送信リクエスタ IPアドレス
`requestDate`	NesDateTime	Required	リクエスト日時
`mailId`	String	Required	メール識別用の固有 ID
`title`	String	Required	メールの件名
`templateSid`	Integer	Optional	照会したテンプレートの SID
`templateName`	String	Required	照会したテンプレートの名前
`emailStatus`	EmailStatus	Required	送信状態
`senderAddress`	String	Required	送信者のメールアドレス
`senderName`	String	Optional	送信者名
`sendDate`	NesDateTime	Optional	送信完了日時
`reservationDate`	NesDateTime	Optional	予約日時
`body`	String	Required	メールの本文
`referencesHeader`	String	Optional	Referencesヘッダ 0~100個で、<unique_id@domain.com>形式の文字列特定のメールをまとめて見るための固有の値フィールドに値を入力すると、その後に同じ値が入力されたメールだけまとめて照会可能 NAVERメールではメールをまとめて見るために使用値が重複する場合、同じメールスレッドと判断してメールをまとめて表示 Referencesヘッダの最上位値だけで判断
`attachFiles`	List<AttachFile>	Optional	添付ファイルリスト
`recipients`	List<Recipient>	Required	受信者リスト
`advertising`	Boolean	Required	広告メールかどうか `true` \| `false` `true`: 広告メール `false`: 一般メール

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード	コード	説明
200	-	リクエスト成功
400	-	認証失敗、無効なリクエスト
400	77101	ログイン情報エラー
400	77102	リクエストエラー
400	77103	リクエストしたリソースが存在しない
403	77201	リクエストしたリソースに対する権限がない
403	77202	メールサービスの使用を申し込んでいないユーザーが呼び出した場合
405	77001	サポートしないメソッドタイプ
415	77002	サポートしないメディアタイプ
500	-	サーバエラー
500	77301	基本プロジェクトが存在しない
500	77302	外部システム API連携エラー
500	77303	その他の内部サーバエラー

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "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
}

この記事は役に立ちましたか?

What's Next

getMailList

リクエスト
レスポンス

タグ

Cloud Outbound Mailer