Recevoir des e-mails : Dossiers et compteurs

Obtenir les compteurs

Obtenez les compteurs de total et de non lus de toute la boîte aux lettres et de chaque dossier.

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

Les totaux à la racine comptent les messages uniques. Les nombres dans chaque dossier comptent les entrées de liste, donc une réponse présente dans Sent et INBOX compte une fois dans chaque dossier.

Arguments

Cet endpoint n'accepte aucun argument.

Démarrage rapide

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

Réponse

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

Champs de la réponse

  • total

    Messages uniques dans la boîte aux lettres.

  • unread

    Messages uniques non lus dans la boîte aux lettres.

  • size_bytes

    Taille totale de la boîte aux lettres.

  • folders.<name>.total

    Entrées dans ce dossier.

  • folders.<name>.unread

    Entrées non lues dans ce dossier.

  • folders.<name>.size_bytes

    Taille de ce dossier.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.