Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function delivers all messages in the server's mail queue.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/deliver_messages_mail_queue
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/deliver_messages_mail_queue
 Command Line
whmapi0 deliver_messages_mail_queue

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "statusmsg": "Mail queue delivery started in background",
  "status": 1,
  "data": "Queue Run Started"
}
 Output (XML)
<deliver_message_mail_queue>
    <data>Queue Run Started</data>
    <status>1</status>
    <statusmsg>Mail queue delivery started in background</statusmsg>
</deliver_message_mail_queue>

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
deliver_message_mail_queue
hash

A hash of the configuration parameter information.

This hash includes the data, status, and statusmsg returns. 

statusmsg

string

The function's status.

The function returns this value in the deliver_message_mail_queue hash.

A valid string in HTML format.
Mail queue delivery started in background

status

Boolean

Whether the function failed.

The function returns this value in the deliver_message_mail_queue hash.

  • 1 — Success.
  • 0 — Failure.
1

data

string

A message of success or reason for failure.

The function returns this value in the deliver_message_mail_queue hash.

A valid string.Queue Run Started