UAPI Functions - cPGreyList::disable_all_domains - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Disable Greylisting on all domains.

$disable_all_domains = $cpanel->uapi(

'cPGreyList', 'disable_all_domains'

);

LiveAPI Perl Module

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',

);

cPanel Template Toolkit

[% execute('SSL', 'disable_all_domains',) %]

Command Line

[% execute('SSL', 'disable_all_domains',) %]

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
domain	string	The domain.	A valid domain on the cPanel account.	example.com
dependencies	array	The domains that your changes will affect.	An array of valid domains on the cPanel account.	"this.com", "that.com", "theother.com",
type	string	The domain type.	main — A main domain. sub — A subdomain.	main
searchhint	string	A 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

Knowledgebase

Categories

Categories