Recevoir des e-mails : Dossiers et compteurs

Lister les dossiers

Listez les dossiers système et vos dossiers personnalisés, avec le total et le nombre de non lus de chacun.

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

Les résultats sont mis en cache pendant 1,5 seconde.

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

Réponse

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

Champs de la réponse

  • folders[].folder

    L'identifiant du dossier (slug). Utilisez-le dans les autres commandes.

  • folders[].name

    Le nom affiché.

  • folders[].system

    true pour les dossiers système, false pour les dossiers personnalisés.

  • folders[].total

    Nombre d'entrées dans le dossier.

  • folders[].unread

    Nombre d'entrées non lues dans le dossier.

Dossiers système

INBOX, Sent, Archive, Trash, Drafts, Spam, Promotions, Snoozed, Scheduled (e-mails en attente d'envoi), Agents (écrits par des agents IA) et NotSubscribing (indique ne pas vouloir acheter ni s'abonner). Les alias comme inbox, archived, draft, junk, promotion et not-subscribing sont acceptés partout où un dossier est attendu.

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.