ユーザの受信フォルダの情報を返します。ユーザはアプリケーションに対して、read_mailboxパーミッションを許可している必要があります。
Columns
| Indexable | Name | Type | Description |
|---|---|---|---|
| * | folder_id | int | フォルダのID。IDは0(受信箱)、1(送信箱)、もしくは4(更新)のいずれかです。 |
| * | viewer_id | int | 受信箱の所有ユーザのID |
| name | string | フォルダの端的な説明文 | |
| unread_count | int | クエリ対象フォルダの未読スレッド数 |
Examples
ユーザの全フォルダに関する全情報を取得します。
SELECT folder_id, name, unread_count FROM mailbox_folder WHERE 1
Usage Notes
現在、ユーザは3つのフォルダ(受信箱、送信箱、更新)しか持っていません。
まずは、アプリケーションの開発とテストのためにread_mailboxパーミッションを取得して始めます。アプリケーションをデプロイする段階で、こちらからInbox APIのホワイトリストに申請してください。