Add email address to BoxTrapper blocked senders

This function blacklists email message senders.

Important:

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

Authorizations:

query Parameters

email required	string <email> The email address for which to blacklist messages. Warning: If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated user. Example: email=user@example.com
queuefile required	string The filename of the email message to blacklist. Examples: Blacklist multiple filenames. queuefile=queuefile=file1&queuefile=file2 Blacklist one filename. queuefile=file1

Responses

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

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  blacklist_messages \
  email='user@example.com' \
  queuefile='file1'

Response samples

Content type

application/json

{"apiversion": 3,
"func": "blacklist_messages",
"module": "BoxTrapper",
"result": {"data": [{"email": "user@example.com",
"failed": 1,
"matches": ["example.msg"
],
"operator": "blacklist",
"reason": "This is a failure message.",
"warning": 1
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}

Next to Delete messages in the BoxTrapper queue