Page tree
Skip to end of metadata
Go to start of metadata

 

Description

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/disable_domains?domains=example.com%7Cexample1.com

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Disable Greylisting on example.com, example1.com, example2.com domains.
$disable_domains = $cpanel->uapi(
    'cPGreyList', 'disable_domains',
    array(
        'domains'     => 'example.com|example1.com',
        )
);

Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Disable Greylisting on example.com, example1.com, example2.com domains.
my $disable_domains = $cpliveapi->uapi(
    'cPGreyList', 'disable_domains',
    {
        'domains'     => 'example.com|example1.com',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Disable Greylisting on example.com, example1.com, example2.com domains. -->
[% execute('cPGreyList', 'disable_domains', { 'domains' => 'example.com|example1.com' }) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username cPGreyList disable_domains domains=example.com%7Cexample1.com

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "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
    }
  ]
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

The domains on which to disable Greylisting.

A pipe-separated list of valid domains that the cPanel account owns.

example.com|example1.com

Returns

Return

TypeDescriptionPossible valuesExample
domainstringThe domain.A valid domain on a 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, the other

enabled

Boolean

Whether Greylisting is disabled.

  • 1 — Enabled.
  • 0 — Disabled.
0