Description


This function enables Greylisting on a cPanel account's selected domains.


Examples




https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/enable_domains?domains=example.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Enable Greylisting on example.com, example1.com, example2.com domains.
$Enable_domains = $cpanel->uapi(
    'cPGreyList', 'enable_domains',
    array(
        'domains'     => 'example.com',
        )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Enable Greylisting on example.com domain.
my $enable_domains = $cpliveapi->uapi(
    'cPGreyList', 'enable_domains',
    {
        'domains'     => 'example.com',
    }
);



<!-- Enable Greylisting on example.com domain. -->
[% execute('cPGreyList', 'enable_domains', { 'domains' => 'example.com' }) %]



uapi --user=username cPGreyList enable_domains domains=example.com



{
  "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

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

The domain on which to enable Greylisting.

To enable Greylisting on multiple domains, use the domains parameter multiple times.


A valid domain that the cPanel account owns.

example.com

Returns

Return

TypeDescriptionPossible valuesExample
domainstringThe 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",

type

stringThe 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, the other

enabled

Boolean

Whether Greylisting is disabled.

  • 1 — Enabled.
  • 0 — Disabled.
0