Return server mail queue contents

This function retrieves the contents of the server's mail queue.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  fetch_mail_queue

Response samples

Content type
application/json
{
  • "data": {
    • "records": [
      • {
        • "frozen": 0,
        • "msgid": "1UotX3-0002HX-Lr",
        • "recipients": [
          • "pricilla@graceland.com"
          ],
        • "sender": "elvis@graceland.com",
        • "size": 14336,
        • "time": 1371552781,
        • "user": null
        }
      ]
    },
  • "metadata": {
    • "command": "fetch_mail_queue",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}