Recibir correos: Carpetas y contadores

Listar carpetas

Lista las carpetas del sistema y tus carpetas personalizadas, con el total y el número de no leídos de cada una.

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

Los resultados se guardan en caché durante 1,5 segundos.

Argumentos

Este endpoint no recibe argumentos.

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

Respuesta

{
  "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 de la respuesta

  • folders[].folder

    El identificador de la carpeta (slug). Úsalo en otros comandos.

  • folders[].name

    El nombre visible.

  • folders[].system

    true para carpetas del sistema, false para carpetas personalizadas.

  • folders[].total

    Número de entradas en la carpeta.

  • folders[].unread

    Número de entradas no leídas en la carpeta.

Carpetas del sistema

INBOX, Sent, Archive, Trash, Drafts, Spam, Promotions, Snoozed, Scheduled (correos esperando a enviarse), Agents (escritos por agentes de IA) y NotSubscribing (dice que no comprará ni se suscribirá). Se aceptan alias como inbox, archived, draft, junk, promotion y not-subscribing en cualquier lugar donde se espere una carpeta.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401TOKEN_EXPIRED

    El access token expiró. Llama a Refresh Token y repite la solicitud.

  • 401INVALID_TOKEN

    El token está mal formado, es desconocido o fue revocado.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 en curso para la misma IP + buzón. Espera la cantidad de segundos indicada en Retry-After.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.