Description

This function disables Greylisting on a cPanel account's domains.


Examples




https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/disable_all_domains



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Disable Greylisting on all domains.
$disable_all_domains = $cpanel->uapi(
    'cPGreyList', 'disable_all_domains'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Disable Greylisting on all domains.
my $disable_all_domains = $cpliveapi->uapi(
    'cPGreyList', 'disable_all_domains',
);



<!-- Disable Greylisting on all domains. -->
[% execute('cpGreyList', 'disable_all_domains',) %]



uapi --user=username cPGreyList disable_all_domains



{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    "transformed": 1
	},
  "warnings": null,
  "data": [
    {
      "domain": "example.com",
      "dependencies": [
        "this.com",
		"that.com",
		"theother.com",
      ],
      "type": "main",
      "searchhint": "this, that, and the other."
      "enabled": 0
    },
	{
	  "domain": "anotherexample.com",
	  "dependencies": [],
	  "enabled": 1,
	  "searchhint": "",
	  "type": "parked"
	}
  ]
}



Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample
domainstringThe domain.A valid domain on the cPanel account.example.com
dependenciesarrayThe domains that your changes will affect.An array of valid domains on the cPanel account.
"this.com",
"that.com",
"theother.com",
typestringThe domain type.
  • main — A main domain.
  • addon — An addon domain.
  • parked — A parked domain.
main
searchhintstringA list of domain-related search terms.A comma-separated list of string values.

this, that, the other

enabled

Boolean

Whether Greylisting is enabled.

  • 1 — Enabled.
  • 0 — Disabled.
0