This function deletes messages in the BoxTrapper queue.
Important:
When you disable the Receive Mail role, the system disables this function.
| 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. queuefile=queuefile=file1.msg&queuefile=file2.msg queuefile=file1.msg |
| all_like | integer Default: 0 Whether to delete all messages that resemble the
Example: all_like=1 |
| apiversion | integer The version of the API. |
| func | string The name of the method called. |
| module | string The name of the module called. |
object |
uapi --user=username BoxTrapper delete_messages email='user@example.com' queuefile='file1.msg'
{- "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
}
}