getMail

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get a list of emails you've requested to send.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/mails/{mailId}

Request headers

For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`mailId`	String	Required	Unique ID to identify each email

Request example

The following is a sample request.

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}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`requestId`	String	Required	Email delivery request ID to distinguish each request `requestId` can contain multiple `mailId` when requesting multiple mailings at once
`requesterIp`	String	Required	Mailing requester IP
`requestDate`	NesDateTime	Required	Request date and time
`mailId`	String	Required	Unique ID to identify each email
`title`	String	Required	Email subject
`templateSid`	Integer	Optional	SID of the queried template
`templateName`	String	Required	Name of the queried template
`emailStatus`	EmailStatus	Required	Delivery Status
`senderAddress`	String	Required	Sender's email address
`senderName`	String	Optional	Sender name
`sendDate`	NesDateTime	Optional	Delivery completion date and time
`reservationDate`	NesDateTime	Optional	Reserved date and time
`body`	String	Required	Email body
`referencesHeader`	String	Optional	References header A string of 20 to 100 characters in the format of <unique_id@domain.com> Unique value for collecting and viewing specific emails If you enter a value in the field, you can collect and view only emails with the same value in the future. It is used in NAVER Mail to collect and view emails If the value is duplicated, it is determined to be the same email thread and the emails are grouped together Only the topmost value of the References header is used to determine
`attachFiles`	List<AttachFile>	Optional	Attachment list
`recipients`	List<Recipient>	Required	Recipient list
`advertising`	Boolean	Required	Whether it is advertising email `true` \| `false` `true`: advertising email `false`: general email

Response status codes

The following describes the response status codes.

HTTP status code	Code	Description
200	-	Request succeeded
400	-	Authentication failed, invalid request
400	77101	Error in login information
400	77102	Request error
400	77103	Requested resource does not exist
403	77201	No permissions to the requested resource
403	77202	Call from a user who hasn't subscribed to the email service
405	77001	Unsupported method type
415	77002	Unsupported media type
500	-	Server error
500	77301	Default project does not exist
500	77302	External system API integration error
500	77303	Other internal server error

Response example

The following is a sample response.

{
  "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":"Partially failed",
    "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":"Recipient",
        "code":"R"
      },
      "received":false,
      "receivedDate":null,
      "status":{
        "label":"Delivery failed",
        "code":"F"
      },
      "retryCount":0,
      "sendResultMessage":"550 5.1.1 No such user 3vir-yOYtA9fRTlWpjkR3 - nsmtp\n",
      "sendResultCode":"RECIPIENT_ADDRESS_ERROR",
      "sendResultCodeMessage":"Delivery failed due to recipient address error."
    },
    {
      "address":"test12@ncp-mail.com",
      "name":"",
      "type":{
        "label":"Recipient",
        "code":"R"
      },
      "received":false,
      "receivedDate":null,
      "status":{
        "label":"Delivery succeeded",
        "code":"S"
      },
      "retryCount":0,
      "sendResultMessage":"Mail sent.",
      "sendResultCode":"MAIL_SENT",
      "sendResultCodeMessage":"Email delivery was successful."
    }
  ],
  "advertising":false
}

Was this article helpful?

What's Next

getMailList

Table of contents

Request
Response