Folder Details
The Folder APIs help you to get and update information about the Folder details of a particular user account.
While using Folder related API, use the OAuth Scope folders.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Get all Folder Details | /api/accounts/<accountId>/folders | GET | folders | To get the details of all the folders in a particular account along with the Folder Id of each folder. |
| Get Details of a Single Folder | /api/accounts/<accountId>/folders/<folderid> | GET | To get the details of a particular folder, based on the Folder Id provided. | |
| Create a new Folder | /api/accounts/<accountId>/folders | POST | Create a new folder with the specified name and details, in the given path. | |
| Rename a Folder | /api/accounts/<accountId>/folders/<folderid> | PUT | To rename a particular folder with the specified name. | |
| Move a Folder | /api/accounts/<accountId>/folders/<folderid> | PUT | To move a folder to a different position in the folder tree. | |
| Enable IMAP view for a Folder | /api/accounts/<accountId>/folders/<folderid> | PUT | To enable IMAP view for the folder, to make it accessible from the IMAP Clients. | |
| Disable IMAP view for a Folder | /api/accounts/<accountId>/folders/<folderid> | PUT | To disable IMAP View for the the folder, to make it not accessible from the IMAP Clients | |
| Mark all emails in a folder as Read | /api/accounts/<accountId>/folders/<folderid> | PUT | To mark all emails in the folder as Read. | |
| Empty Folder | /api/accounts/<accountId>/folders/<folderid> | PUT | To delete all emails in the folder. | |
| Delete Folder | /api/accounts/<accountId>/folders/<folderid> | DELETE | To delete the folder along with the emails and sub-folders |