UAPI Functions - cPGreyList::enable_all_domains

Description

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

Examples 


 cPanel or Webmail Session URL

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

 cPanel Template Toolkit

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

 Command Line

uapi --user=username cPGreyList enable_all_domains

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 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

domains

string

The domain.

A valid domain on the cPanel account.

example.com

 dependencies 

array

 An array of 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, and the other. 

enabled

 Boolean 

Whether Greylisting is enabled.

  • 1 — Enabled.
  • 0 — Disabled.

0

 

  • 46 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....