SendcorexDocs

Receive Emails: Folders & counters

Create Folder

Create a custom folder. The response gives you the slug to use in other commands.

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

Use the returned folder (slug) in move, list_threads and the other commands. The folder name works too, but the slug never changes.

Arguments

  • namestringrequired

    Folder name, from 1 to 64 characters.

  • colorstringoptional

    Folder color.

  • iconstringoptional

    Folder icon.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "create_folder",
        args: {
          name: "Projeto X"
        }
      }
    ]
  },
  { 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": "create_folder",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "folder": "projeto-x",
        "name": "Projeto X"
      }
    }
  ]
}

Response fields

  • folder

    The folder slug.

  • name

    The folder name you sent.

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.

  • CMDINVALID_ARGS

    A required argument is missing or invalid.

  • CMDALREADY_EXISTS

    A folder with this name already exists.

  • CMDINTERNAL

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