Query this table to return information about a user's Inbox folders. The user needs to grant the calling application the read_mailbox extended permission.
Highlighted rows are indexable / searchable and one is usually required in the WHERE portion of the query.
|folder_id||int||The ID of the folder being queried. The ID can be one of: 0 (for Inbox), 1 (for Outbox), or 4 (for Updates).|
|viewer_id||int||The ID of the user whose Inbox you are querying.|
|name||string||A short description of the folder being queried.|
|unread_count||int||The number of unread threads in the folder being queried.|
Get all information about all of a user's folders.
SELECT folder_id, name, unread_count FROM mailbox_folder WHERE 1
- Currently, all users only have three Inbox folders: Inbox (folder_id = 0), Outbox (folder_id = 1), and Updates (folder_id = 4)
- To get started, as a developer you can access the Inbox APIs via the read_mailbox permission in order to develop and test your application. To launch your application to all users, please apply to the Inbox API whitelist.