- Created by Documentation, last modified on Oct 05, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
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:
MailSend
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.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
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/whmapi1
{ "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>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
user | string | Required The cPanel account. | A valid cPanel account. Note: You cannot suspend the | example |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 56+
Methods:
GET, POST
Required Parameters:
user
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Sections - Mail — Mail functions manage your server's mail configurations.
-
Page:WHM API 1 Functions - list_pops_for — This function lists a cPanel account’s email accounts.
-
Page:WHM API 1 Functions - get_user_email_forward_destination — This function retrieves the destination to which the system forwards a system account's email.
-
Page:WHM API 1 Functions - set_user_email_forward_destination — This function sets the destination to which the system forwards a system account's email.
-
Page:WHM API 1 Functions - generate_mobileconfig — This function generates a mobile configuration profile for an email account.