Receber e-mails: Pastas e contadores

Listar pastas

Liste as pastas do sistema e as suas pastas personalizadas, com o total e a contagem de não lidas de cada uma.

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

Os resultados ficam em cache por 1,5 segundo.

Argumentos

Este endpoint não recebe argumentos.

Início rápido

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);

Resposta

{
  "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
          }
        ]
      }
    }
  ]
}

Campos da resposta

  • folders[].folder

    O identificador da pasta (slug). Use-o nos outros comandos.

  • folders[].name

    O nome de exibição.

  • folders[].system

    true para pastas do sistema, false para pastas personalizadas.

  • folders[].total

    Número de entradas na pasta.

  • folders[].unread

    Número de entradas não lidas na pasta.

Pastas do sistema

INBOX, Sent, Archive, Trash, Drafts, Spam, Promotions, Snoozed, Scheduled (e-mails aguardando envio), Agents (escritos por agentes de IA) e NotSubscribing (diz que não vai comprar nem assinar). Aliases como inbox, archived, draft, junk, promotion e not-subscribing são aceitos em qualquer lugar onde se espera uma pasta.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.