GET/users/{userId}/mail/mailfolders/{folderId}/children

특정 메일함의 메일 목록을 조회한다.

주의
수신확인 메일함은 조회할 수 없다. 수신확인 여부는 각 메일의 status를 참고한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

mail
mail.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/mail/mailfolders/{folderId}/children

Path Parameters

ParameterTypeDescription
userId string 

구성원 ID (URL인코딩하여 사용)

  • User ID
  • Login ID(email)
  • 자기자신(me)

required
example : me 
folderId string 

메일함 ID


required
example : 1 

Query Parameters

ParameterTypeDescription
count integer 

페이지 개수


default : 30
minimum : 5
maximum : 200
example : 30
format : int32 
cursor string 

다음 목록 조회 시 사용하는 값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
searchFilterType string 

검색 필터링 타입

  • all: 모든 메일(기본값)
  • mark: 중요 메일
  • attach: 첨부메일
  • tome: 나에게 온 메일

default : all
Allowed values : all, mark, attach, tome
example : all 
isUnread boolean 

안 읽은 메일 여부(기본값 : false)


default : false
example : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
mails array (object) 

메일 목록 정보


required
uniqueItems : true 
unreadCount number 

안 읽은 메일 개수


required 
folderName string 

메일함 이름


required
minLength : 1
maxLength : 250 
listCount integer 

현재 목록에서의 메일 개수


required
format : int64 
totalCount integer 

폴더 내의 메일 수


required
format : int64 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

object

PropertyTypeDescription
mailId integer 

메일 공유 ID


required
format : int64 
folderId integer 

메일함 ID


required
format : int32 
status string 

메일 상태

  • Unread: 안 읽은 메일
  • Read: 읽은 메일

required
minLength : 1 
from object (from) 

메일 정보

 
to array (MailAddress) 

받는사람


minItems : 1
uniqueItems : true 
subject string 

메일 제목


required
minLength : 1 
receivedTime string 

메일 수신 시간


required
example : 2021-07-16T19:20:30+09:00 
sentTime string 

메일 발송 시간


required
example : 2021-07-16T19:20:30+09:00 
size integer 

메일 크기


required
format : int64 
isImportant boolean 

메일을 쓸 때 중요 메일 여부(메일 제목에 빨간 느낌표 표시)


required 
securityLevel string 

메일의 보안 등급

  • General: 일반
  • Restricted: 대외비
  • Confidential: 기밀
  • Non-business: 업무외

required 
useForwarding boolean 

메일 재전송 가능 여부

  • true: 가능
  • false: 불가능

required 
attachCount integer 

첨부 파일 개수


required
format : int32 

from

PropertyTypeDescription
name string 

메일 이름

 
email string 

메일 주소 (RFC822 format)


required
minLength : 1 

MailAddress

PropertyTypeDescription
name string 

메일 이름

 
email string 

메일 주소 (RFC822 format)


required
minLength : 1 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값

 

Response Example

example

1{2  "mails": [3    {4      "mailId": 76289,5      "folderId": 1,6      "status": "Read",7      "from": {8        "name": "admin",9        "email": "admin@example.com"10      },11      "to": [12        {13          "name": "Aaron Wisozk",14          "email": "clovis.spinka9@example.com"15        }16      ],17      "subject": "test",18      "receivedTime": "2022-10-27T00:02:01+09:00",19      "sentTime": "2022-10-27T00:02:01+09:00",20      "size": 1406,21      "isImportant": true,22      "securityLevel": "General",23      "useForwarding": true,24      "attachCount": 025    },26    {27      "mailId": 76288,28      "folderId": 1,29      "status": "Read",30      "from": {31        "name": "admin",32        "email": "admin@example.com"33      },34      "to": [35        {36          "name": "nvmail043",37          "email": "nvmail043@example.com"38        }39      ],40      "subject": "test",41      "receivedTime": "2022-10-27T00:02:01+09:00",42      "sentTime": "2022-10-27T00:02:01+09:00",43      "size": 1246,44      "isImportant": true,45      "securityLevel": "General",46      "useForwarding": true,47      "attachCount": 048    }49  ],50  "unreadCount": 15354,51  "folderName": "전체메일",52  "listCount": 2,53  "totalCount": 123,54  "responseMetaData": {55    "nextCursor": "3"56  }57}

HTTP 204

No Content

HTTP 500

Internal Server Error