Return email filter's information

This function retrieves an email filter's information.

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=user@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/get_filter

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "get_filter",
"module": "Email",
"result": {"data": {"actions": [{"action": "deliver",
"dest": "/dev/null",
"number": 1
}
],
"filtername": "coffee",
"metadata": {"transformed": 1
},
"rules": [{"match": "contains",
"number": 1,
"opt": "or",
"part": "$message_body",
"val": "coconut"
}
]
},
"errors": null,
"messages": null,
"status": 1,
"warnings": null
}
}