Receive Emails: Folders & counters
List Folders
List the system folders and your custom folders, with the total and unread count of each.
https://g.sendcorex.com/v1command: list_foldersResults are cached for 1.5 seconds.
Arguments
This endpoint takes no arguments.
Quick start
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "list_folders"
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Response
{
"type": "SUCCESS",
"results": [
{
"command": "list_folders",
"id": "0",
"type": "SUCCESS",
"data": {
"folders": [
{
"folder": "INBOX",
"name": "INBOX",
"system": true,
"total": 12,
"unread": 3
},
{
"folder": "Sent",
"name": "Sent",
"system": true,
"total": 8,
"unread": 0
},
{
"folder": "projeto-x",
"name": "Projeto X",
"system": false,
"total": 4,
"unread": 1
}
]
}
}
]
}Response fields
folders[].folderThe folder identifier (slug). Use it in other commands.
folders[].nameThe display name.
folders[].systemtruefor system folders,falsefor custom folders.folders[].totalNumber of entries in the folder.
folders[].unreadNumber of unread entries in the folder.
System folders
INBOX, Sent, Archive, Trash, Drafts, Spam, Promotions and Snoozed. Aliases such as inbox, archived, draft, junk and promotion are accepted anywhere a folder is expected.
Errors
HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.
- 401
TOKEN_EXPIREDThe access token has expired. Call Refresh Token and repeat the request.
- 401
INVALID_TOKENThe token is malformed, unknown or revoked.
- 429
RATE_LIMITEDMore than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.
- CMD
INTERNALServer error. The detail is only written to the server log.