Receive Emails: Rules
Test Rule
See how many of the recent emails in a folder a rule would catch before you save it or turn it on.
https://g.sendcorex.com/v1command: test_ruleTested on the subject, sender, recipients and preview of the stored emails. body and header conditions are checked in full only when a new email arrives.
Arguments
idstringoptionalA saved rule (also works if it is turned off).
ruleobjectoptionalOr an unsaved rule, same format as Create Rule.
folderstringoptionalDefaults to INBOX.
limitnumberoptionalHow many recent emails to check, 1 to 500. Defaults to 200.
Quick start
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);Response
{
"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"
]
}
}
}
]
}Response fields
matchedHow many of the scanned emails match.
examplesUp to 10 of them.
would_doWhat the rule does when it matches.
Errors
HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.
- 401
TOKEN_EXPIREDThe access token has expired. Call Refresh Token and repeat the request.
- 401
INVALID_TOKENThe token is malformed, unknown or revoked.
- 429
RATE_LIMITEDMore than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.
- CMD
INVALID_ARGSA required argument is missing or invalid.
- CMD
INVALID_RULEThe rule is not valid. The message says which condition or action and why.
- CMD
NOT_FOUNDThe message, thread or folder does not exist for this token.
- CMD
INTERNALServer error. The detail is only written to the server log.