Recevoir des e-mails : Lecture

Lister les messages

Listez les messages un par un, sans les regrouper en conversations. Vous pouvez aussi lister tous les messages qui portent un libellé.

POSThttps://g.sendcorex.com/v1command: list_messages

Arguments

  • folderstringfacultatif

    Dossier à lister. Par défaut INBOX.

  • limitnumberfacultatif

    Taille de page, de 1 à 100. Par défaut 25.

  • cursorstringfacultatif

    Le next_cursor de la page précédente.

  • is_readbooleanfacultatif

    Filtre par état de lecture. Ce filtre parcourt le dossier.

  • is_starredbooleanfacultatif

    Filtre par étoile. Ce filtre parcourt le dossier.

  • is_importantbooleanfacultatif

    Filtre par importance. Ce filtre parcourt le dossier.

  • is_spambooleanfacultatif

    Filtre par spam. Ce filtre parcourt le dossier.

  • afterstringfacultatif

    Uniquement les messages reçus à cette date ou après. RFC 3339, YYYY-MM-DD (UTC) ou epoch en millisecondes.

  • beforestringfacultatif

    Uniquement les messages reçus avant cette date. Mêmes formats que after.

  • labelstringfacultatif

    Liste les messages portant ce libellé dans tous les dossiers. folder et les filtres booléens sont ignorés. Insensible à la casse. after et before fonctionnent toujours.

    ex. : "cliente-vip"

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "list_messages",
        args: {
          folder: "INBOX",
          is_read: false,
          limit: 50
        }
      }
    ]
  },
  { 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_messages",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "messages": [
          {
            "message_uid": "Vj0xQUJDMTIz",
            "thread_id": "thr_9a1c4e72",
            "folder": "INBOX",
            "subject": "Invoice for September",
            "preview": "Hi, attached is the invoice for September…",
            "from_name": "Ana Costa",
            "from_email": "ana@client.com",
            "has_attachments": false,
            "size_bytes": 4821,
            "is_read": false,
            "is_starred": false,
            "is_important": false,
            "is_spam": false,
            "snoozed_until": null,
            "received_at": "2026-10-09T14:21:07Z"
          }
        ],
        "has_more": false,
        "next_cursor": null
      }
    }
  ]
}

Champs de la réponse

  • messages[].message_uid

    L'id du message.

  • messages[].thread_id

    La conversation à laquelle appartient le message.

  • messages[].folder

    Le dossier de cette entrée.

  • messages[].subject / preview

    Objet et court aperçu.

  • messages[].from_name / from_email

    L'expéditeur.

  • messages[].has_attachments / size_bytes

    Indicateur de pièce jointe et taille du message.

  • messages[].is_read / is_starred / is_important / is_spam

    État du message.

  • messages[].snoozed_until

    Date d'échéance d'un message mis en attente, ou null.

  • messages[].received_at

    Date de réception du message.

  • has_more / next_cursor

    Pagination.

Lister par libellé

Avec label, la commande lit l'index des libellés : seuls les messages libellés sont examinés. Chaque message est renvoyé avec son état actuel dans tous les dossiers, vous obtenez donc folders et labels au lieu d'un seul folder.

Données de réponse avec libellé

{
  "messages": [
    {
      "message_uid": "Vj0xQUJDMTIz",
      "thread_id": "thr_9a1c4e72",
      "subject": "Invoice for September",
      "preview": "Hi, attached is the invoice for September…",
      "from_name": "Ana Costa",
      "from_email": "ana@client.com",
      "folders": [
        "INBOX"
      ],
      "labels": [
        "cliente-vip"
      ],
      "is_read": false,
      "is_starred": false,
      "is_important": false,
      "received_at": "2026-10-09T14:21:07Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide.

  • CMDINVALID_CURSOR

    Le curseur est mal formé ou appartient à un autre compte ou dossier.

  • CMDINTERNAL

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