Return account BoxTrapper allowlist rules

This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.

Important:

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

SecurityBasicAuth

Request

query Parameters

required

string <email>

A valid email address on the cPanel account.

Warning:

If you call this function in Webmail, the system overrides this parameter. This parameter defaults to the current 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_allowlist

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "get_allowlist",
"module": "BoxTrapper",
"result": {"data": ["from allowlisted-email\\@domain\\.com"
],
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}