Receber e-mails: Pastas e contadores

Obter contadores

Obtenha os contadores de total e de não lidas da caixa de correio inteira e de cada pasta.

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

Os totais na raiz contam mensagens únicas. Os números dentro de cada pasta contam entradas de listagem, então uma resposta que está em Sent e em INBOX conta uma vez em cada pasta.

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

Resposta

{
  "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 da resposta

  • total

    Mensagens únicas na caixa de correio.

  • unread

    Mensagens únicas não lidas na caixa de correio.

  • size_bytes

    Tamanho total da caixa de correio.

  • folders.<name>.total

    Entradas nessa pasta.

  • folders.<name>.unread

    Entradas não lidas nessa pasta.

  • folders.<name>.size_bytes

    Tamanho dessa 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.