We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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


 cPanel Analytics

participate_in_analytics

 Server Administration

add_configclusterserver

configurebackgroundprocesskiller

configureservice

cors_proxy_get

create_user_session

delete_configclusterserver

enable_monitor_all_enabled_services

get_all_contact_importances

get_api_calls

get_api_pages

get_appconfig_application_list

get_application_contact_event_importance  

get_application_contact_importance

get_available_profiles

get_current_profile

get_linked_server_node

get_password_strength

get_remote_access_hash

get_server_node_status

get_service_config

get_service_config_key

get_tcp4_sockets

get_tcp6_sockets

get_tweaksetting

get_udp4_sockets

get_udp6_sockets

get_update_availability

get_users_links

getdiskusage

gethostname

is_role_enabled

link_server_node_with_api_token

list_configclusterservers

list_linked_server_nodes

list_user_worker_nodes

loadavg

nvget

nvset

personalization_get

personalization_set

purchase_a_license

reboot

remove_in_progress_exim_config_edit

restartservice

restore_config_from_file

restore_config_from_upload

run_cpkeyclt

send_test_posturl

send_test_pushbullet_note

servicestatus

set_application_contact_event_importance

set_application_contact_importance  

set_primary_servername

set_service_config_key

set_service_proxy_backends

set_tweaksetting

sethostname

setminimumpasswordstrengths

start_profile_activation

system_needs_reboot

systemloadavg

unlink_server_node

uapi_cpanel

unset_all_service_proxy_backends

update_configclusterserver

update_contact_email

update_linked_server_node

verify_aim_access

verify_icq_access

verify_oscar_access

verify_posturl_access

verify_pushbullet_access

verify_slack_access


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.

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