Update account BoxTrapper allowlist

This function sets the 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

rules

required

Array of strings

An array of allowlist rules.

Note:

You can set multiple allowlist rules, duplicate or increment the parameter name. For example, rules-1, rules-2, and rules-3.

Examples:

Set multiple rules. rules=rules-1='allowlisted-email\@domain\.com' rules-2='from allowlisted-email2\@domain\.com' rules-3='to domain2\.com'

Set multiple rules. rules=rules='allowlisted-email\@domain\.com' rules='from allowlisted-email2\@domain\.com' rules='to domain2\.com'

Set a single rule. rules=allowlisted-email\@domain\.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/set_allowlist

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty --user=username BoxTrapper set_allowlist email='user@example.com' rules-1='allowlisted-email\@domain\.com' rules-2='from allowlisted-email2\@domain\.com' rules-3='to domain2\.com'

Response samples

application/json

{"apiversion": 3,
"func": "set_allowlist",
"module": "BoxTrapper",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}