GET/users/{userId}/mail/mailfolders

메일함 목록을 조회한다.

Authorization

oauth2

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

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

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

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

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
mailFolders array (MailFolder) 

메일함 정보


required
minItems : 1
uniqueItems : true 

MailFolder

PropertyTypeDescription
folderId integer 

메일함 ID


required
format : int32 
folderType string 

메일함 타입

  • S: 시스템 메일함
  • U: 사용자가 생성한 메일함

required
minLength : 0
Allowed values : S, U 
folderName string 

메일함 이름


required
minLength : 1
maxLength : 100 
unreadMailCount integer 

안 읽은 메일 개수


required
format : int32 
mailCount integer 

총 메일 개수


required
format : int32 
usage integer 

메일함 사용 용량


required
format : int32 
folderDepth integer 

메일함의 계층 구조


format : int32 
parentFolderId integer 

계층 구조의 메일함에서 상위 메일함의 ID


format : int32 
hasChildFolder boolean 

계층 구조의 메일함에서 하위 메일함이 있는지 여부

 

Response Example

example

1{2  "mailFolders": [3    {4      "folderId": 0,5      "folderType": "S",6      "folderName": "받은메일함",7      "unreadMailCount": 15356,8      "mailCount": 15540,9      "usage": 37151934610    },11    {12      "folderId": 1,13      "folderType": "S",14      "folderName": "보낸메일함",15      "unreadMailCount": 0,16      "mailCount": 159,17      "usage": 6221908218    }19  ]20}