Description

This function enables Greylisting on all of the cPanel account's domains.

Examples 


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

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

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

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

uapi --user=username cPGreyList enable_all_domains

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

Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample
domainsstringThe domain.A valid domain on the cPanel account.example.com
dependenciesarrayAn array of 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.
  • sub — A subdomain.
main
searchhintstringA list of domain-related search terms.A comma-separated list of string values.

this, that, and the other.

enabled

Boolean

Whether Greylisting is enabled.

  • 1 — Enabled.
  • 0 — Disabled.
0