GET/users/{userId}/mail/mailfolders

メールフォルダリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン 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": 3715193410    },11    {12      "folderId": 1,13      "folderType": "S",14      "folderName": "送信済みメール",15      "unreadMailCount": 0,16      "mailCount": 159,17      "usage": 6221908218    }19  ]20}