Enable email filter for email account

This function enables an email filter.

Important:

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

SecurityBasicAuth

Request

query Parameters

account required	string <email> The email address that owns the filter. Example: account=username@example.com
filtername required	string The filter's name. Example: filtername=coffee

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/enable_filter

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  enable_filter \
  account='username@example.com' \
  filtername='coffee'

Response samples

application/json

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