Receber e-mails: Regras

Listar regras

As regras da caixa de correio na ordem em que rodam, com quantas vezes cada uma bateu.

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

Argumentos

Este endpoint não recebe argumentos.

Início rápido

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);

Resposta

{
  "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
      }
    }
  ]
}

Campos da resposta

  • rules[]

    Em ordem de execução (position). hits e last_hit_at mostram quais regras são de fato usadas.

  • max_rules

    Até 100 regras por caixa de correio.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.