Recibir correos: Reglas

Aplicar regla

Ejecuta una regla sobre los correos que ya están en una carpeta: mover, etiquetar, leído, destacado e importante.

POSThttps://g.sendcorex.com/v1command: apply_rule
!

Confiar, bloquear, posponer y respuesta automática solo se aplican a correos nuevos, nunca a los antiguos.

Argumentos

  • idstringopcional

    Una regla guardada.

  • ruleobjectopcional

    O una regla sin guardar.

  • folderstringopcional

    Por defecto INBOX.

  • limitnumberopcional

    Correos recientes que recorrer, 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: "apply_rule",
        args: {
          id: "Vj0xUlVMRTAx",
          folder: "INBOX",
          limit: 500
        }
      }
    ]
  },
  { 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": "apply_rule",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "folder": "INBOX",
        "scanned": 500,
        "applied": 37,
        "failed": 0,
        "moved_to": null,
        "not_applied_to_existing": [
          "auto_reply"
        ]
      }
    }
  ]
}

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.