Recevoir des e-mails : Indicateurs et libellés

Définir les indicateurs

Marquez des messages comme lus ou non lus, suivis et importants. Fonctionne sur un message ou sur un lot.

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

Les commandes groupées répondent élément par élément : un id manquant ne fait pas échouer les autres.

Arguments

  • idsstring[]facultatif

    Jusqu'à 100 ids de message.

  • idstringfacultatif

    Un seul id de message. Utilisez-le ou ids.

  • is_readbooleanfacultatif

    Marque comme lu (true) ou non lu (false).

  • is_starredbooleanfacultatif

    Ajoute ou retire l'étoile.

  • is_importantbooleanfacultatif

    Ajoute ou retire l'indicateur important.

  • scopestringfacultatif

    message (par défaut) ou thread. N'affecte que is_read.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "set_flags",
        args: {
          ids: [
            "Vj0xQUJDMTIz"
          ],
          is_read: true,
          scope: "thread"
        }
      }
    ]
  },
  { 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": "set_flags",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "items": [
          {
            "id": "Vj0xQUJDMTIz",
            "ok": true,
            "data": {
              "changed": 2
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Champs de la réponse

  • items[].id

    L'id auquel se rapporte cet élément.

  • items[].ok

    true si la modification a réussi pour cet id.

  • items[].data

    Le résultat pour cet id. Uniquement quand ok vaut true.

  • items[].code / message

    L'erreur pour cet id. Uniquement quand ok vaut false.

  • ok_count / failed_count

    Combien d'ids ont réussi et combien ont échoué.

Comportement des indicateurs

  • is_read + scope: thread

    Marque toute la conversation.

  • is_starred / is_important: true

    Marque uniquement le message de l'id.

  • is_starred / is_important: false

    Retire l'indicateur dans toute la conversation. Une ligne de conversation affiche « a une étoile », donc retirer l'étoile doit la retirer de tous les messages.

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.

  • CMDNOT_FOUND

    Le message, la conversation ou le dossier n'existe pas pour ce token.

  • CMDINTERNAL

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