GET/users/{userId}/mail/mailfolders

Gets a list of folders.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

Member ID (must be URL-encoded)

  • 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) 

Folder information


required
minItems : 1
uniqueItems : true 

MailFolder

PropertyTypeDescription
folderId integer 

Folder ID


required
format : int32 
folderType string 

Folder type

  • S: System folder
  • U: User-created folder

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

Folder name


required
minLength : 1
maxLength : 100 
unreadMailCount integer 

Number of unread messages


required
format : int32 
mailCount integer 

Total number of messages


required
format : int32 
usage integer 

Folder usage


required
format : int32 
folderDepth integer 

Folder depth


format : int32 
parentFolderId integer 

Parent folder ID


format : int32 
hasChildFolder boolean 

Indicates whether the folder has a child folder.

 

Response Example

example

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