- Created by Documentation, last modified on Apr 09, 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 marks the IP addresses for the specified mail provider as not trusted. Greylisting defers emails from non-trusted IP addresses.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/cpgreylist_untrust_entries_for_common_mail_provider?api.version=1&provider=cpanel&provider-0=dpanel
https://hostname.example.com:2087/cpsess##########/xml-api/cpgreylist_untrust_entries_for_common_mail_provider?api.version=1&provider=cpanel&provider-0=dpanel
whmapi1 cpgreylist_untrust_entries_for_common_mail_provider provider=cpanel provider-0=dpanel
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
{ "data": { "providers_untrusted": { "cpanel": { "ips_untrusted": 21 } }, "providers_failed": { "dpanel": "Unknown mail provider: dpanel\n" } }, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "cpgreylist_untrust_entries_for_common_mail_provider" } }
<result> <data> <providers_untrusted> <cpanel> <ips_untrusted>21</ips_trusted> </cpanel> </providers_untrusted> <providers_failed> <dpanel>Unknown mail provider: dpanel\n</dpanel> </providers_failed> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>cpgreylist_trust_entries_for_common_mail_provider</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
provider | string | Required. The mail provider. Note: To trust multiple mail providers, increment the parameter name (for example, | Call WHM API 1's | cpanel |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
providers_untrusted | hash | A hash of the mail providers that Greylisting does not trust. | This hash includes the provider_key return. | |
| hash | A hash of the mail provider's data. Note: The hash's name is the mail provider's key name. The function returns this hash in the | This hash includes the | |
| integer | The total number of the mail provider's IP addresses that Greylisting does not trust. The function returns this value in the | A positive integer. | 21 |
| hash | A hash of the mail providers that failed to update. | This hash includes the | |
| string | The reason why the change for a provider failed. Note: The return's name is the mail provider's key name. The function returns this value in the | A valid string. | Unknown mail provider. |
Function information
API Version:
Available in:
WHM 11.52+
Methods:
GET, POST
Required Parameters:
provider
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 Functions - cpgreylist_is_server_netblock_trusted — This function returns the Greylisting trusted status of the server's netblock.
-
Page:WHM API 1 Functions - cpgreylist_status — This function returns the status of Greylisting.
-
Page:WHM API 1 Functions - create_cpgreylist_trusted_host — This function adds an IP address to the Greylisting Trusted Hosts list.
-
Page:WHM API 1 Functions - delete_cpgreylist_trusted_host — This function deletes an IP address from the Greylisting Trusted Hosts list.
-
Page:WHM API 1 Functions - disable_cpgreylist — This function disables Greylisting.