Send messages in the BoxTrapper queue

This function delivers 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 sender's cPanel account email address for which to deliver email 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 messages to deliver. Note: To deliver multiple email messages, pass this parameter multiple times. Examples: Deliver multiple email messages. queuefile=queuefile=example.msg&queuefile=example1.msg&queuefile=example2.msg Deliver a single email message. queuefile=example.msg
all_like	integer Default: 0 Whether to deliver all messages that resemble the `queuefile` parameter's value. `1` - Deliver all similar messages. `0` - Don't deliver all similar messages. Enum: 0 1 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/deliver_messages

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

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