Recibir correos: Reglas

Probar regla

Mira cuántos de los correos recientes de una carpeta atraparía una regla antes de guardarla o activarla.

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

Se prueba con el asunto, el remitente, los destinatarios y la vista previa de los correos guardados. Las condiciones de body y header solo se comprueban por completo cuando llega un correo nuevo.

Argumentos

  • idstringopcional

    Una regla guardada (también funciona si está desactivada).

  • ruleobjectopcional

    O una regla sin guardar, con el mismo formato que Crear regla.

  • folderstringopcional

    Por defecto INBOX.

  • limitnumberopcional

    Cuántos correos recientes revisar, de 1 a 500. Por defecto 200.

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

Respuesta

{
  "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 de la respuesta

  • matched

    Cuántos de los correos revisados coinciden.

  • examples

    Hasta 10 de ellos.

  • would_do

    Lo que hace la regla cuando coincide.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401TOKEN_EXPIRED

    El access token expiró. Llama a Refresh Token y repite la solicitud.

  • 401INVALID_TOKEN

    El token está mal formado, es desconocido o fue revocado.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 en curso para la misma IP + buzón. Espera la cantidad de segundos indicada en Retry-After.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido.

  • CMDINVALID_RULE

    La regla no es válida. El mensaje indica qué condición o acción y por qué.

  • CMDNOT_FOUND

    El mensaje, la conversación o la carpeta no existe para este token.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.