Filters
All operations require authentication.
List filtersProduction
List filters. Returns the names of the filters of the email account. Get one to read its action, its priority and whether it is active.
Path parameters
Name of account
Name of your domain name
Response
Example uses accountName = string, domain = string
$ curl https:/[ "string"]
Get a filterProduction
Get a filter. Returns the account, priority, active state, action (accept, account, delete or redirect) and action parameter of the filter.
Path parameters
Name of account
Name of your domain name
Filter name
Response
Action of filter
acceptaccountdeleteredirectAction parameter of filter
If true filter is active
Domain name of filter
Filter name
Account name of filter
Priority of filter
Example uses accountName = string, domain = string, name = string
$ curl https:/{ "action": "accept", "actionParam": "string", "active": true, "domain": "string", "name": "string", "pop": "string", "priority": 0}
Create a filterProduction
Create a filter. Creates a filter with a rule on a header (operand and value), an action, a priority and an active state, and returns the task.
Path parameters
Name of account
Name of your domain name
Request body (required)
Action of filter
acceptaccountdeleteredirectAction parameter of filter
If true filter is active
Header to be filtered
Filter name
Rule of filter
checkspfcontainsnoContainsPriority of filter
Rule parameter of filter
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses accountName = string, domain = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
Delete a filterProduction
Delete a filter. Removes the filter and its rules from the email account, and returns the tasks. Incoming emails are no longer filtered by it.
Path parameters
Name of account
Name of your domain name
Filter name
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses accountName = string, domain = string, name = string
$ curl https:/[ { "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z" }]
Enable or disable a filterProduction
Enable or disable a filter. Set activity to true to apply the filter to incoming emails, or to false to suspend it.
Path parameters
Name of account
Name of your domain name
Filter name
Request body (required)
New activity
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses accountName = string, domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
Change filter priorityProduction
Change filter priority. Sets the priority of the filter, which gives the order the filters of the account are applied in.
Path parameters
Name of account
Name of your domain name
Filter name
Request body (required)
New priority
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses accountName = string, domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
List filter rulesProduction
List filter rules. Returns the IDs of the rules of the filter. Get one to read the header it checks, its operand and its value.
Path parameters
Name of account
Name of your domain name
Filter name
Response
Example uses accountName = string, domain = string, name = string
$ curl https:/[ 0]
Get a filter ruleProduction
Get a filter rule. Returns the header, the operand (checkspf, contains or noContains) and the value of the rule.
Path parameters
Name of account
Name of your domain name
Filter name
Response
Header to be filtered
Rule of filter
checkspfcontainsnoContainsRule parameter of filter
Example uses accountName = string, domain = string, id = 0, name = string
$ curl https:/{ "header": "string", "id": 0, "operand": "checkspf", "value": "string"}
Create a filter ruleProduction
Create a filter rule. Adds a rule to the filter on a header, with an operand (checkspf, contains or noContains) and a value, and returns the task.
Path parameters
Name of account
Name of your domain name
Filter name
Request body (required)
Header to be filtered
Rule of filter
checkspfcontainsnoContainsRule parameter of filter
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses accountName = string, domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z"}
Delete a filter ruleProduction
Delete a filter rule. Removes the rule from the filter and returns the tasks. The filter keeps applying its other rules.
Path parameters
Name of account
Name of your domain name
Filter name
Response
Account name of task
Action of task
Domain name of task
Id of task
Creation date of task
Example uses accountName = string, domain = string, id = 0, name = string
$ curl https:/[ { "account": "string", "action": "string", "domain": "string", "id": 0, "timestamp": "2024-01-01T12:00:00Z" }]