getMail
    • PDF

    getMail

    • PDF

    기사 요약

    Email 발송요청 상세 조회
    발송 요청한 목록을 조회합니다.

    GET https://mail.apigw.fin-ntruss.com/api/v1/mails/{mailId}
    

    요청

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    mailIdYesStringEmail ID (각 메일 한 건을 구분하는 ID)

    응답

    HTTP 상태코드설명
    200성공
    400인증 실패, 잘못된 요청
    500서버 에러

    예시

    요청 예시

    GET https://mail.apigw.fin-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
    }
    

    속성

    항목필수 여부타입제약사항설명
    requestIdYesString- Email 발송 요청 ID
    각 요청을 구분하는 ID로, 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음
    mailIdYesStringEmail ID (각 메일 한 건을 구분하는 ID)
    requesterIpYesStringEmail 발송 요청자 IP
    titleYesString메일 제목
    bodyYesString메일 내용
    templateSidNoInteger템플릿 ID
    templateNameNoString템플릿 명
    senderAddressYesString발송자 Email 주소
    senderNameNoString발송자 이름
    emailStatusYesStatus발송 상태
    requestDateYesNesDateTime요청일시
    sendDateNoNesDateTime발송완료 일시
    reservationDateNoNesDateTime예약일시
    advertisingYesBoolean광고메일 여부
    referencesHeaderNoString- References 헤더
    다음의 형태가 되어야 함: <unique_id@domain.com>
    네이버 메일에서는 References 헤더에 따라 메일을 모아 볼 수 있음. 특정 메일을 모아서 보기 위해서는 Unique 한 값이 입력 되어야만 함
    값이 중복되는 경우 같은 메일 쓰레드로 판단하여 메일을 묶어서 노출 됨
    하나의 값만 입력해도 가능(References 헤더의 최상단 값만으로만 판단)
    attachFilesNoList<AttachFile>첨부파일 목록
    recipientsYesList<Recipient>수신자 목록

    에러 코드

    HTTP Status Code리턴 코드응답 메시지
    40077101로그인 정보 오류
    40077102BAD_REQUEST
    40077103리소스가 존재하지 않음
    40377201권한 없음
    40377202Email 상품 사용신청 하지 않음
    40577001METHOD_NOT_ALLOWED
    41577002UNSUPPORTED_MEDIA_TYPE
    50077301기본 프로젝트가 존재하지 않음
    50077302외부 시스템 API 연동 오류
    50077303그외 INTERNAL_SERVER_ERROR

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.