Update email address's email filter order

This function modifies the filter order for an email address. For more information about Exim filters, read Exim's documentation.

Important:

When you disable the Receive Mail role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

filter* required	string A mail filter name. For each mail filter to reorder, supply a `filter` parameter, where `` is a number that represents the filter's order. For example, to set `coffee` as the first email filter and `cheesecloth` as the second, set `coffee` as the `filter1` parameter's value, and `cheesecloth` as the value for the `filter2` parameter. Example: filter*=coffee
mailbox required	string The email address. Example: mailbox=user@example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Email/reorder_filters

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  reorder_filters \
  mailbox='user@example.com' \
  filter*='coffee'

Response samples

application/json

{"apiversion": 3,
"func": "reorder_filters",
"module": "Email",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}