Description

This function returns Greylisting's status for a cPanel account's domains.

Examples 


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

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List status of Greylisting on domains.
$list_domains = $cpanel->uapi(
    'cPGreyList', 'list_domains'
);

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

<!-- List status of Greylisting on domains. -->
[% execute('cPGreyList', 'list_domains',) %]

uapi --user=username cPGreyList list_domains

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    "transformed": 1,
    "cPGreyList": {
      "total_disabled": 1,
      "total_enabled": 0
    }
  },
  "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
cPGreyListhashA hash of the number of domains with Greylisting enabled or disabled.This hash contains the total_disabled and total_enabled returns. 

total_disabled

integer

The number of domains with Greylisting disabled.

The function returns this value in the cPGreyList hash.

A positive integer.1

total_enabled

integer

The number of domains with Greylisting enabled.

The function returns this value in the cPGreyList hash.

A positive integer.0
domainstringThe domain.A valid domain on the cPanel account.example.com
dependenciesarrayAn array of domains that your changes to a selected domain 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 comma-separated 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