Return email account's BoxTrapper queued messages

This function returns a list of messages in the account's BoxTrapper queue.

Important:

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

SecurityBasicAuth

Request

query Parameters

email required	string <email> The email account for which to retrieve queued messages. Important: 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
date	integer <unix_timestamp> Default: "the current time" The date for which to return queued messages. Example: date=1556812881

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

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  list_queued_messages \
  email='user@example.com'

Response samples

application/json

{"apiversion": 3,
"func": "list_queued_messages",
"module": "BoxTrapper",
"result": {"data": [{"from": "user@example.com",
"queuefile": "example.msg",
"subject": "Email Message Subject",
"time": 1556812881
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}