Recevoir des e-mails : Règles

Appliquer une règle

Exécutez une règle sur les e-mails déjà présents dans un dossier : déplacer, libeller, lu, étoile et important.

POSThttps://g.sendcorex.com/v1command: apply_rule
!

La confiance, le blocage, la mise en attente et la réponse automatique ne s'appliquent qu'aux nouveaux e-mails, jamais aux anciens.

Arguments

  • idstringfacultatif

    Une règle enregistrée.

  • ruleobjectfacultatif

    Ou une règle non enregistrée.

  • folderstringfacultatif

    Par défaut INBOX.

  • limitnumberfacultatif

    E-mails récents à parcourir, de 1 à 500. Par défaut 200.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "apply_rule",
        args: {
          id: "Vj0xUlVMRTAx",
          folder: "INBOX",
          limit: 500
        }
      }
    ]
  },
  { 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": "apply_rule",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "folder": "INBOX",
        "scanned": 500,
        "applied": 37,
        "failed": 0,
        "moved_to": null,
        "not_applied_to_existing": [
          "auto_reply"
        ]
      }
    }
  ]
}

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_RULE

    La règle n'est pas valide. Le message indique quelle condition ou action, et pourquoi.

  • 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.