Menerima Email: Aturan

Uji aturan

Lihat berapa banyak email terbaru di sebuah folder yang akan ditangkap aturan sebelum Anda menyimpan atau mengaktifkannya.

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

Diuji pada subjek, pengirim, penerima, dan pratinjau email yang tersimpan. Kondisi body dan header hanya diperiksa sepenuhnya saat email baru tiba.

Argumen

  • idstringopsional

    Aturan tersimpan (juga berfungsi jika sedang nonaktif).

  • ruleobjectopsional

    Atau aturan yang belum disimpan, format sama seperti Buat aturan.

  • folderstringopsional

    Default INBOX.

  • limitnumberopsional

    Berapa banyak email terbaru yang diperiksa, 1 sampai 500. Default 200.

Mulai cepat

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

Respons

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

Field respons

  • matched

    Berapa banyak email yang dipindai yang cocok.

  • examples

    Hingga 10 di antaranya.

  • would_do

    Apa yang dilakukan aturan saat cocok.

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401TOKEN_EXPIRED

    Access token sudah kedaluwarsa. Panggil Refresh Token lalu ulangi request.

  • 401INVALID_TOKEN

    Token salah format, tidak dikenal, atau dicabut.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 yang sedang diproses untuk IP + kotak surat yang sama. Tunggu sesuai jumlah detik di Retry-After.

  • CMDINVALID_ARGS

    Argumen wajib tidak ada atau tidak valid.

  • CMDINVALID_RULE

    Aturan tidak valid. Pesannya menyebutkan kondisi atau tindakan mana dan alasannya.

  • CMDNOT_FOUND

    Pesan, percakapan, atau folder tidak ada untuk token ini.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.