getMail

Classic/VPC 환경에서 이용 가능합니다.

발송 요청한 이메일 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/mails/{mailId}

요청 헤더

Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`mailId`	String	Required	각 이메일을 식별하기 위한 고유한 ID

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://mail.apigw.gov-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	-	각 요청을 구분하기 위한 이메일 발송 요청 ID 한 번에 여러 건의 이메일 발송을 요청할 경우, `requestId`는 여러 개의 `mailId`를 포함할 수 있음
`requesterIp`	String	-	이메일 발송 요청자 IP
`requestDate`	Object	-	요청 일시 NesDateTime 참조
`mailId`	String	-	각 이메일을 식별하기 위한 고유한 ID
`title`	String	-	이메일 제목
`templateSid`	Integer	-	조회한 템플릿의 SID
`templateName`	String	-	조회한 템플릿의 이름
`emailStatus`	Object	-	발송 상태 EmailStatus 참조
`senderAddress`	String	-	발송자 이메일 주소
`senderName`	String	-	발송자 이름
`sendDate`	Object	-	발송 완료 일시 NesDateTime 참조
`reservationDate`	Object	-	예약 일시 NesDateTime 참조
`body`	String	-	이메일 본문
`referencesHeader`	String	-	References 헤더 0~100개로 <unique_id@domain.com> 형식의 문자열 특정 이메일을 모아서 보기 위한 고유한 값 필드에 값을 입력하면 추후 동일 값이 입력된 메일만 모아서 조회 가능 네이버 메일에서는 이메일을 모아서 보기 위해 사용 값이 중복되는 경우 같은 메일 스레드로 판단하여 메일을 묶어서 노출 References 헤더의 최상단 값으로만 판단
`attachFiles`	List	-	첨부 파일 목록 AttachFile
`recipients`	List	-	수신자 목록 Recipient 참조
`advertising`	Boolean	-	광고 메일 여부 `true` \| `false` `true`: 광고 메일 `false`: 일반 메일

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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