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

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

注意
受信確認メールボックスは参照できません。 受信状態の確認には、各メールの status を参照します。

Authorization

oauth2

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

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 エンコードする)

  • ユーザー ID (userId)
  • ログイン 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 

リストのカーソル値 (URL エンコードする)


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 (MailInFolder) 

メールリスト情報


required
uniqueItems : true 
unreadCount integer 

未読メール数


required 
folderName string 

メールフォルダ名


required
minLength : 1
maxLength : 250 
listCount integer 

レスポンスに含まれるメール数


required
format : int64 
totalCount integer 

フォルダ内のメール数


required
format : int64 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

MailInFolder

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 : false 
subject string 

件名


required
minLength : 1 
receivedTime string 

受信時刻


required
minLength : 1 
sentTime string 

送信時刻


required
minLength : 1 
size integer 

メールサイズ


required
format : int64 
isImportant boolean 

重要メールフラグ (件名に赤いエクスクラメーションマークを表示)


required 
securityLevel string 

情報レベル

  • General : 公開
  • Restricted : 社外秘
  • Confidential : 機密

required 
useForwarding boolean 

メール再送可能フラグ

  • true : 可能
  • false : 不可能

required 
attachCount integer 

添付ファイル数


required
format : int32 

from

PropertyTypeDescription
name string 

名前

 
email string 

メールアドレス (RFC822 フォーマット)


required
minLength : 1 

MailAddress

PropertyTypeDescription
name string 

名前

 
email string 

メールアドレス (RFC822 フォーマット)


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