Description

This function sets Exim's queue to hold email that a user sends to an external address.


If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in the queue.

Examples 



https://hostname.example.com:2087/cpsess##########/json-api/hold_outgoing_email?api.version=1&user=example




https://hostname.example.com:2087/cpsess##########/xml-api/hold_outgoing_email?api.version=1&user=example




whmapi1 hold_outgoing_email user=example



{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "hold_outgoing_email"
  }
}




<result>
   <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>hold_outgoing_email</command>
    </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account.

A valid cPanel account.

You cannot suspend the root user's outgoing email with this function.


example

Returns

This function only returns metadata. 


Function information



API Version:


WHM API 1




Available in:


WHM 56+




Methods:


GET, POST




Required Parameters:


user




Return Formats:


JSON, XML



About WHM API 1

Find a function

Related functions