Developer Documentation
Child pages
  • WHM API 1 Functions - hold_outgoing_email
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

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

Note:

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.

Important:

In cPanel & WHM version 76 and later, when you disable the MailSend role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/hold_outgoing_email?api.version=1&user=example
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/hold_outgoing_email?api.version=1&user=example
 Command Line
whmapi1 hold_outgoing_email user=example


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "hold_outgoing_email"
  }
}
 Output (XML)
<result>
   <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>hold_outgoing_email</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account.

A valid cPanel account.

Note:

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

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions