Recibir correos: Carpetas y contadores

Obtener contadores

Obtén los contadores de total y no leídos de todo el buzón y de cada carpeta.

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

Los totales en la raíz cuentan mensajes únicos. Los números dentro de cada carpeta cuentan entradas de listado, así que una respuesta que está en Sent e INBOX cuenta una vez en cada carpeta.

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

Respuesta

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

Campos de la respuesta

  • total

    Mensajes únicos en el buzón.

  • unread

    Mensajes únicos no leídos en el buzón.

  • size_bytes

    Tamaño total del buzón.

  • folders.<name>.total

    Entradas en esa carpeta.

  • folders.<name>.unread

    Entradas no leídas en esa carpeta.

  • folders.<name>.size_bytes

    Tamaño de esa 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.