Skip to content
MailDock Docs

/mail/filters/apply

POST
/mail/filters/apply
curl --request POST \
  --url https://example.com/api/v1/mail/filters/apply \
  --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
skipped
required
Array<string>
Allowed values: redirect redirect_copy reply reject
Example
{
  "skipped": [
    "redirect"
  ]
}