Receive Emails: Flags & labels

List Labels

The labels of the mailbox with their colors.

POSThttps://g.sendcorex.com/v1command: list_labels

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_labels"
      }
    ]
  },
  { 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_labels",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "labels": [
          {
            "id": "clients",
            "name": "Clients",
            "color": "blue"
          }
        ],
        "colors": [
          "emerald",
          "blue",
          "purple",
          "orange",
          "red",
          "pink",
          "teal",
          "amber",
          "indigo",
          "gray"
        ],
        "max_labels": 100
      }
    }
  ]
}

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.