Receive Emails: Rules
Apply Rule
Run a rule on the emails already in a folder: move, label, read, star and important.
https://g.sendcorex.com/v1command: apply_ruleTrust, block, snooze and auto-reply only apply to new emails, never to old ones.
Arguments
idstringoptionalA saved rule.
ruleobjectoptionalOr an unsaved rule.
folderstringoptionalDefaults to INBOX.
limitnumberoptionalRecent emails to go through, 1 to 500. Defaults to 200.
Quick start
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);Response
{
"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"
]
}
}
]
}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.