Delete messages in the BoxTrapper queue

This function deletes messages in the BoxTrapper queue.

Important:

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

SecurityBasicAuth

Request

query Parameters

email 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
queuefile required	string The filename of the email message who's sender to delete. Warning: To delete multiple email message senders, duplicate the parameter name. Examples: Delete multiple filenames. queuefile=queuefile=file1.msg&queuefile=file2.msg Delete a single filename. queuefile=file1.msg
all_like	integer Default: 0 Whether to delete all messages that resemble the `queuefile` parameter's value. `1` - Delete all messages resembling the `queuefile` parameter. `0` - Do not delete all messages resembling the `queuefile` parameter. Enum: 1 0 Example: all_like=1

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

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "delete_messages",
"module": "BoxTrapper",
"result": {"data": [{"email": "user@example.com",
"failed": 1,
"matches": ["example.msg"
],
"operator": "delete",
"reason": "(XID d9myfd) The system failed to locate the requested message:",
"warning": 1
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}