Mail

List mail filters

Lists the rules applied to incoming mail.

GET /v1/mail/filters

Permission

The key must be granted mail.settings.read

A key without it gets 403 insufficient_scope, with the missing permission named in details.

Rules applied to incoming mail, in priority order.

Request

curl https://api.veruapis.com/v1/mail/filters \
  -H "Authorization: Bearer vak_live_..."

Response

Field Type Description
id string
name string
priority integer Lower numbers run first.
enabled boolean
rule object What the rule matches and what it does. Its fields are below.

The rule

Field Type Description
match string all requires every condition; any requires one. allany Defaults to all
conditions required object[] What to test. At least one. Its fields are below.
actions required object[] What to do when it matches. At least one. Its fields are below.

Each item in conditions

Field Type Description
field required string Or header:<name>, for example header:list-id. fromtoccsubjectbody
op required string Matching ignores case. regex is reserved and refused. containsequalsstarts_withends_with
value required string What to look for.

Each item in actions

Field Type Description
type required string moveset_flagmark_readmark_unreaddiscard
folder string Required for move. The folder is created if it does not exist.
flag string Required for set_flag.
{
  "data": { ... },
  "meta": { "request_id": "req_01j8z9...", "timestamp": "2026-09-02T10:00:00Z" }
}

A worked example for this endpoint has not been written yet.

Errors

Every failure uses the same shape, with a stable string code you can branch on. See the error reference.

Related

GET /v1/mail/filters

Runs the real request against your own workspace. The key is used once and never stored.