メール詳細の照会

Prev Next

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

送信リクエストに含まれるメール1件の詳細情報を照会します。メールの件名・本文と添付ファイルリスト、受信者ごとの送信結果(recipients[])を一緒に返します。

リクエスト

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

メソッド URI
GET /mail/v2/services/{serviceId}/requests/{requestId}/mails/{mailId}

リクエストヘッダ

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

フィールド 必須の有無 説明
x-ncp-lang Optional レスポンスメッセージの言語
  • en-US (デフォルト) | ko-KR | ja-JP

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

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceId String Required メールサービス ID
requestId String Required 送信リクエスト ID
mailId String Required メール ID

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/mail/v2/services/ncp:mail:kr:1********2:main/requests/20260712-R-01K0ZQ8YV3M4N5P6R7S8T9VAWX-777/mails/20260712-M-01K0ZQ8YVBQ7C2D3E4F5G6H7J8-777' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-lang: ja-JP'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
requestId String - 送信リクエスト ID
mailId String - メール ID
requesterIp String - 送信をリクエストしたクライアントの IPアドレス
  • コンソール送信と API送信のいずれもリクエスト時点の送信元アドレスを記録
createDateTime String - 送信リクエストの受付日時
  • ISO 8601形式
title String - メールの件名
  • 置換変数が実際の値に置換された結果
templateNo Integer - 使用したテンプレート番号
  • テンプレートを使用しない送信はnull
templateName String - 使用したテンプレート名
  • テンプレートを使用しない送信はnull
status String - メールの送信状態
  • READY | RESERVED | SENDING | COMPLETED | FAILED | PARTIAL_FAILED | CANCELED
    • READY: 送信開始を待機中
    • RESERVED: 予約した送信時刻を待機中
    • SENDING: メールを送信中
    • COMPLETED: メールに含まれるすべての受信者への送信が完了
    • FAILED: メールに含まれるすべての受信者への送信が失敗
    • PARTIAL_FAILED: メールに含まれる受信者の一部への送信が失敗
    • CANCELED: 送信がキャンセルされた
senderAddress String - 送信者のメールアドレス
senderName String - 送信者名
  • 入力しない送信はnull
sendDateTime String - 送信完了日時
  • ISO 8601形式
  • 送信が開始されていないメールはnull
reservationDateTime String - 予約送信日時
  • ISO 8601形式
  • 即時送信はnull
body String - メールの本文
  • 置換変数が実際の値に置換された結果
  • advertisingがtrueの場合は受信拒否文言を含む
advertising Boolean - 広告メールの有無
  • true | false
attachFiles Array - 添付ファイルリスト: attachFiles
  • 添付ファイルがない場合は空の配列
recipients Array - 受信者ごとの送信結果リスト: recipients
  • CC、BCCの受信者を含む
  • 一般送信は受信者を30人単位に分割してメールを作成するため、項目数は最大30
  • 個別送信は受信者1人あたりメール1通のため、項目は1つ

attachFiles

attachFilesの説明は次の通りです。

フィールド タイプ 必須の有無 説明
fileId String - 添付ファイル ID
fileName String - 添付ファイル名
  • 最大100文字
fileSize Integer - 添付ファイルサイズ(Byte)

recipients

recipientsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
address String - 受信者のメールアドレス
name String - 受信者名
  • 入力しない受信者はnull
type String - 受信者タイプ
  • TO | CC | BCC
    • TO: 宛先
    • CC: CC
    • BCC: BCC
received Boolean - 開封の有無
  • true | false
    • true: 受信者がメールを開封した
    • false: 開封していない
receivedDateTime String - 開封日時
  • ISO 8601形式
  • 開封していない場合はnull
status String - 受信者ごとの送信状態
  • READY | RESERVED | SENDING | RETRYING | COMPLETED | FAILED | ERRORED | UNSUBSCRIBED | BLOCKED | CANCELED
    • READY: 送信開始を待機中
    • RESERVED: 予約した送信時刻を待機中
    • SENDING: 受信者へのメール配信を試行中
    • RETRYING: 一時的な失敗により再試行が予約され待機中
    • COMPLETED: 受信者にメールが正常に送信された
    • FAILED: 受信サーバの拒否などにより送信が失敗
    • ERRORED: 送信処理中のエラーにより終了
    • UNSUBSCRIBED: 受信拒否アドレスのため送信されなかった
    • BLOCKED: 送信ブロックアドレスのため送信されなかった
    • CANCELED: 送信がキャンセルされた
retryCount Integer - 送信再試行回数
  • 初回送信は再試行に含まれない
sendResultCode String - 送信結果コード
  • すべての値はsendResultCodeを参照
  • 値が追加される可能性のあるオープンな集合
  • 送信が完了していない受信者はnull
sendResultMessage String - 送信結果の原文メッセージ
  • 受信メールサーバが返した SMTPレスポンスの原文
  • 送信が完了していない受信者はnull

sendResultCode

recipients[].sendResultCodeの説明は次の通りです。

コード 説明
CANCELED_MAIL 送信キャンセル
CONNECTION_ABNORMAL 接続異常による一時的な送信失敗
CONTENT_HAS_TAG_FORM メールコンテンツ内に置換タグが存在するため送信失敗
DKIM_FAIL DKIMエラーによりメール送信失敗
EMPTY_BODY_CONTENT システムエラーによりメール本文を設定できず送信失敗
MAILBOX_ABNORMAL 受信者メールボックスの異常による一時的な送信失敗
MAILBOX_ERROR 受信者メールボックスのエラーによる送信失敗
MAIL_CONTENTS_ERROR メールコンテンツのエラーによる送信失敗
MAIL_SENT 送信成功
MIME_MESSAGE_CREATE_FAIL システムエラーにより MIMEメッセージを作成できず送信失敗
NETWORK_ABNORMAL ネットワーク異常による一時的な送信失敗
NETWORK_ERROR ネットワークエラーによる送信失敗
NONEXISTENT_DOMAIN_ADDRESS 受信者ドメインが存在しないため送信失敗
RECEIVE_MAIL_SERVICE_ABNORMAL 受信者メールサービスの異常による一時的な送信失敗
RECEIVE_MAIL_SERVICE_ERROR 受信者メールサービスのエラーによる送信失敗
RECIPIENT_ADDRESS_ERROR 受信者アドレスのエラーによる送信失敗
RESENDING_MAIL 再送信中
RESEND_MAIL_FAIL 再送信試行回数の超過による送信失敗
SECURITY_AND_POLICY_ABNORMAL セキュリティおよびポリシーの異常による一時的な送信失敗
SECURITY_AND_POLICY_ERROR セキュリティおよびポリシーのエラーによる送信失敗
SEND_BLOCK_ADDRESS 送信ブロックされた受信者への送信リクエストのためブロック
SMTP_ABNORMAL 受信側との SMTP異常による一時的な送信失敗
SMTP_ERROR 受信側との SMTPエラーによる送信失敗
TEST_MAIL_SEND システムのテストメール送信
UNDEFINED_ERROR 未定義のエラーによる送信失敗
UNKNOWN_CAUSE_FAIL システム内外で発生した不明なエラーによる送信失敗
UNKNOWN_DOMAIN_ADDRESS 不明なドメインまたはブロックされたドメインを含むアドレスへの送信リクエストのため失敗
UNSUBSCRIBE_ADDRESS 受信拒否したアドレスへの送信リクエストのためブロック
UNSUPPORTED_ENCODING_ADDRESS 受信者アドレスのエンコード失敗による送信失敗
READ_TIMED_OUT 受信サーバの無応答による送信失敗
CONNECTION_ERROR 受信サーバの接続終了による送信失敗
参考
  • mailIdはパスのrequestIdに属するメールである必要があります。権限のある呼び出し元に限り、属していない場合は404を返します。
  • 送信が完了していないメールは、sendDateTime、recipients[].sendResultCode、recipients[].sendResultMessageがnullです。

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

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

HTTPステータスコード コード メッセージ 説明
200 - OK リクエスト成功
400 InvalidParameter Bad Request リクエストパラメータエラー
401 Unauthorized Unauthorized 認証失敗
403 Forbidden Forbidden パスのserviceIdに対する権限なし
404 NotFound Not Found パスのrequestIdまたはmailIdが存在しない
500 InternalServerError Internal Server Error サーバ内部エラー
参考

Simple & Easy Notification Serviceの他の APIとは異なり、メール v2 APIは NCP API標準のエラー形式でエラーを返します。レスポンスボディのstatus、error(文字列)フィールドの代わりに、以下のerrorオブジェクトが返されます。

エラーレスポンスボディ

呼び出しに失敗した場合のレスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
error Object - エラー情報
error.errorCode String - エラーコード
  • レスポンスステータスコード表のコード列を参照
error.message String - エラーコードごとの固定メッセージ
  • x-ncp-langヘッダで指定した言語で返される
error.detail String - リクエストごとの詳細な理由
  • 該当する理由がない場合はフィールドが省略される
error.fieldErrors Array - パラメータごとのエラーリスト
  • field: エラーが発生したパラメータ名
  • message: エラーの理由
  • パラメータエラーでない場合はフィールドが省略される

エラーレスポンス例

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
"error": {
"errorCode": "NotFound",
"message": "The requested resource was not found."
}
}

レスポンス例

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

{
"requestId": "20260712-R-01K0ZQ8YV3M4N5P6R7S8T9VAWX-777",
"mailId": "20260712-M-01K0ZQ8YVBQ7C2D3E4F5G6H7J8-777",
"requesterIp": "203.0.113.42",
"createDateTime": "2026-07-12T15:19:53+09:00",
"title": "山田太郎様、ようこそ。",
"templateNo": 41,
"templateName": "会員ランク変更のご案内",
"status": "PARTIAL_FAILED",
"senderAddress": "no_reply@company.com",
"senderName": "カスタマーセンター",
"sendDateTime": "2026-07-12T15:19:53+09:00",
"reservationDateTime": null,
"body": "<body>お客様の会員ランクが SILVERから GOLDに変更されました。</body>",
"advertising": false,
"attachFiles": [
{
"fileId": "8f14e45fceea167a5a36dedd4bea2543",
"fileName": "会員ランク案内.pdf",
"fileSize": 204800
}
],
"recipients": [
{
"address": "yamada@example.com",
"name": "山田太郎",
"type": "TO",
"received": false,
"receivedDateTime": null,
"status": "COMPLETED",
"retryCount": 0,
"sendResultCode": "MAIL_SENT",
"sendResultMessage": "Mail sent."
},
{
"address": "test12@example.com",
"name": null,
"type": "CC",
"received": false,
"receivedDateTime": null,
"status": "FAILED",
"retryCount": 0,
"sendResultCode": "RECIPIENT_ADDRESS_ERROR",
"sendResultMessage": "550 5.1.1 No such user - nsmtp"
}
]
}