Recevoir des e-mails : Règles

Tester une règle

Voyez combien d'e-mails récents d'un dossier une règle intercepterait avant de l'enregistrer ou de l'activer.

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

Testé sur l'objet, l'expéditeur, les destinataires et l'aperçu des e-mails stockés. Les conditions body et header ne sont entièrement vérifiées qu'à l'arrivée d'un nouvel e-mail.

Arguments

  • idstringfacultatif

    Une règle enregistrée (fonctionne aussi si elle est désactivée).

  • ruleobjectfacultatif

    Ou une règle non enregistrée, au même format que Créer une règle.

  • folderstringfacultatif

    Par défaut INBOX.

  • limitnumberfacultatif

    Nombre d'e-mails récents à vérifier, 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: "test_rule",
        args: {
          rule: {
            name: "Invoices",
            conditions: [
              {
                field: "subject",
                op: "contains",
                value: "invoice"
              }
            ],
            actions: [
              {
                type: "label",
                value: "Finance"
              }
            ]
          },
          folder: "INBOX"
        }
      }
    ]
  },
  { 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": "test_rule",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "folder": "INBOX",
        "scanned": 200,
        "matched": 12,
        "examples": [
          {
            "message_uid": "Vj0xQUJDMTIz",
            "thread_id": "thr_9a1c4e72",
            "subject": "Invoice #123",
            "from_name": "Ana Costa",
            "from_email": "ana@client.com",
            "received_at": "2026-10-24T03:10:00Z"
          }
        ],
        "would_do": {
          "folder": "",
          "labels": [
            "Finance"
          ],
          "matched": [
            "Invoices"
          ]
        }
      }
    }
  ]
}

Champs de la réponse

  • matched

    Nombre d'e-mails analysés qui correspondent.

  • examples

    Jusqu'à 10 d'entre eux.

  • would_do

    Ce que fait la règle quand elle correspond.

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.