Skip to content
MailDock Docs

/mailboxes/{id}/filters (PUT)

PUT
/mailboxes/{id}/filters
curl --request PUT \
  --url https://example.com/api/v1/mailboxes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/filters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "rules", "rules": [], "raw": "" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
mode
string
default: rules
Allowed values: rules raw
rules
Array<object>
default: <= 100 items
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
raw
string
"" <= 64000 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
mailboxId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
mode
required
string
Allowed values: rules raw
rules
required
Array<object>
object
name
required
string
>= 1 characters <= 100 characters
enabled
required
boolean
default: true
match
required
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
required
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
required
boolean
default: true
raw
required
string
autoresponder
required
object
enabled
required
boolean
subject
required
string
"" <= 200 characters
body
required
string
"" <= 10000 characters
intervalDays
required
integer
default: 1 >= 1 <= 30
startsAt
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))$/
endsAt
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))$/
script
required
string
pushedAt
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))$/
updatedAt
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))$/
Example
{
  "mode": "rules",
  "rules": [
    {
      "enabled": true,
      "match": "all",
      "conditions": [
        {
          "type": "header",
          "operator": "contains",
          "value": ""
        }
      ],
      "actions": [
        {
          "type": "fileinto"
        }
      ],
      "stop": true
    }
  ],
  "autoresponder": {
    "enabled": false,
    "subject": "",
    "body": "",
    "intervalDays": 1,
    "startsAt": null,
    "endsAt": null
  }
}