Add email account to Exim ignore list

This function marks email message senders for Exim to ignore.

Important:

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

SecurityBasicAuth

Request

query Parameters

email required	string <email> The cPanel email account from which to ignore messages. 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
queuefile required	string The filename of the email message to ignore. Note: To ignore multiple email messages, duplicate this parameter. Examples: Ignore multiple email messages. queuefile=queuefile-1=example1.msg queuefile-2=example2.msg queuefile-3=example3.msg Ignore a single email message. queuefile=example.msg

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/ignore_messages

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "ignore_messages",
"module": "BoxTrapper",
"result": {"data": [{"email": "user@example.com",
"matches": ["example.msg"
],
"operator": "ignore"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}