Recevoir des e-mails : Règles

Lister les règles

Les règles de la boîte aux lettres dans leur ordre d'exécution, avec le nombre de correspondances de chacune.

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

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_rules"
      }
    ]
  },
  { 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_rules",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "rules": [
          {
            "id": "Vj0xUlVMRTAx",
            "rule_id": "Vj0xUlVMRTAx",
            "name": "Clients always in Inbox",
            "match": "all",
            "conditions": [
              {
                "field": "from_domain",
                "op": "in_list",
                "value": "acme.com, globex.com"
              },
              {
                "field": "provider",
                "op": "is_any_of",
                "value": [
                  "microsoft_365",
                  "google_workspace"
                ]
              }
            ],
            "except": [
              {
                "field": "subject",
                "op": "contains",
                "value": "newsletter"
              }
            ],
            "actions": [
              {
                "type": "keep_inbox"
              },
              {
                "type": "label",
                "value": "Clients"
              },
              {
                "type": "star"
              }
            ],
            "stop": false,
            "timezone": "Asia/Kuala_Lumpur",
            "enabled": true,
            "position": 0,
            "hits": 128,
            "last_hit_at": "2026-10-25T09:12:44Z",
            "created_at": "2026-10-01T02:00:00Z",
            "updated_at": "2026-10-20T08:30:00Z"
          }
        ],
        "max_rules": 100
      }
    }
  ]
}

Champs de la réponse

  • rules[]

    Dans l'ordre d'exécution (position). hits et last_hit_at montrent quelles règles sont réellement utilisées.

  • max_rules

    Jusqu'à 100 règles par boîte aux lettres.

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.