Receber e-mails: Regras

Aplicar regra

Rode uma regra nos e-mails que já estão em uma pasta: mover, marcar, lida, estrela e importante.

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

Confiar, bloquear, adiar e resposta automática só se aplicam a e-mails novos, nunca aos antigos.

Argumentos

  • idstringopcional

    Uma regra salva.

  • ruleobjectopcional

    Ou uma regra não salva.

  • folderstringopcional

    O padrão é INBOX.

  • limitnumberopcional

    E-mails recentes a percorrer, 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: "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);

Resposta

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

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.