Child pages
  • WHM API 1 Functions - suspend_outgoing_email
Skip to end of metadata
Go to start of metadata

Description

This function sets Exim's queue to suspend and force failure for 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 queue.

Important:

In cPanel & WHM version 76, the MailSend role affects this function.

Examples 


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


Notes:

  • 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/api/whmapi1

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "suspend_outgoing_email"
  }
}
 Output (XML)
<result>
   <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>suspend_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.