Description

This function unfreezes messages from the mail server's queue.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/unfreeze_messages_mail_queue
https://hostname.example.com:2087/cpsess##########/xml-api/unfreeze_messages_mail_queue
whmapi0 unfreeze_messages_mail_queue

{
  "statusmsg": "Mail queue remove started in background",
  "status": 1,
  "data": "Removal Run Started"
}
<purge_mail_queue>
    <data>Removal Run Started</data>
    <status>1</status>
    <statusmsg>Mail queue remove started in background</statusmsg>
</purge_mail_queue>

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
datastring

The mail server's response.

A valid string.
Removal Run Started

status

Boolean

Whether the function succeeded.

 

  • 1 — Success.
  • 0 — Failure.
1

statusmsg

string

The function's status.

 

A valid string.
Mail queue remove started in background