Return email account's BoxTrapper configuration

This function retrieves an account's BoxTrapper configuration.

Important:

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

SecurityBasicAuth

Request

query Parameters

required

string <email>

The account's email address.

Warning:

If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.

Example: email=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/BoxTrapper/get_configuration

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  get_configuration \
  email='user@example.com'

Response samples

application/json

{"apiversion": 3,
"func": "get_configuration",
"module": "BoxTrapper",
"result": {"data": {"enable_auto_whitelist": 1,
"from_addresses": "user@example.com,user2@example.com",
"from_name": "User",
"queue_days": 14,
"spam_score": 2.5,
"whitelist_by_association": 1
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}