Skip to content
MailDock Docs

/mail/filters/try

POST
/mail/filters/try
curl --request POST \
  --url https://example.com/api/v1/mail/filters/try \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rule": { "name": "example", "enabled": true, "match": "all", "conditions": [ { "type": "header", "header": "example", "operator": "contains", "value": "" } ], "actions": [ { "type": "fileinto", "folder": "example" } ], "stop": true }, "folder": "INBOX" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
rule
required
object
name
required
string
>= 1 characters <= 100 characters
enabled
boolean
default: true
match
string
default: all
Allowed values: all any
conditions
required
Array
>= 1 items <= 20 items
One of:
object
type
required
string
Allowed values: header
header
required
string
/^[!-9;-~]{1,64}$/
operator
required
string
Allowed values: contains not_contains is not_is matches not_matches starts_with not_starts_with ends_with not_ends_with regex not_regex exists not_exists
value
string
"" <= 998 characters
actions
required
Array
>= 1 items <= 10 items
One of:
object
type
required
string
Allowed values: fileinto
folder
required
string
>= 1 characters <= 255 characters
stop
boolean
default: true
folder
string
default: INBOX >= 1 characters <= 1000 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
folder
required
string
total
required
integer
>= -9007199254740991 <= 9007199254740991
examined
required
integer
>= -9007199254740991 <= 9007199254740991
matched
required
integer
>= -9007199254740991 <= 9007199254740991
messages
required
Array<object>
object
uid
required
integer
>= -9007199254740991 <= 9007199254740991
from
required
string
subject
required
string
date
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
Examplegenerated
{
  "folder": "example",
  "total": 1,
  "examined": 1,
  "matched": 1,
  "messages": [
    {
      "uid": 1,
      "from": "example",
      "subject": "example",
      "date": "2026-04-15T12:00:00Z"
    }
  ]
}