Receber e-mails: Regras

Testar regra

Veja quantos dos e-mails recentes de uma pasta uma regra pegaria antes de salvá-la ou ligá-la.

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

Testado no assunto, remetente, destinatários e prévia dos e-mails armazenados. Condições de body e header só são verificadas por completo quando chega um e-mail novo.

Argumentos

  • idstringopcional

    Uma regra salva (funciona também se estiver desligada).

  • ruleobjectopcional

    Ou uma regra não salva, no mesmo formato de Criar regra.

  • folderstringopcional

    O padrão é INBOX.

  • limitnumberopcional

    Quantos e-mails recentes verificar, de 1 a 500. O padrão é 200.

Início rápido

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

Resposta

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

Campos da resposta

  • matched

    Quantos dos e-mails varridos batem.

  • examples

    Até 10 deles.

  • would_do

    O que a regra faz quando bate.

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.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDINVALID_RULE

    A regra não é válida. A mensagem diz qual condição ou ação e por quê.

  • CMDNOT_FOUND

    A mensagem, conversa ou pasta não existe para este token.

  • CMDINTERNAL

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