Receive Emails: Folders & counters

Get Counters

Get the total and unread counters of the whole mailbox and of every folder.

POSThttps://g.sendcorex.com/v1command: get_counters
i

The totals at the root count unique messages. The numbers inside each folder count listing entries, so a reply that lives in Sent and INBOX counts once in each folder.

Arguments

This endpoint takes no arguments.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_counters"
      }
    ]
  },
  { 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": "get_counters",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "total": 20,
        "unread": 3,
        "size_bytes": 1048576,
        "folders": {
          "INBOX": {
            "total": 12,
            "unread": 3,
            "size_bytes": 482113
          },
          "Sent": {
            "total": 8,
            "unread": 0,
            "size_bytes": 566463
          }
        }
      }
    }
  ]
}

Response fields

  • total

    Unique messages in the mailbox.

  • unread

    Unique unread messages in the mailbox.

  • size_bytes

    Total size of the mailbox.

  • folders.<name>.total

    Entries in that folder.

  • folders.<name>.unread

    Unread entries in that folder.

  • folders.<name>.size_bytes

    Size of that folder.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401TOKEN_EXPIRED

    The access token has expired. Call Refresh Token and repeat the request.

  • 401INVALID_TOKEN

    The token is malformed, unknown or revoked.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.