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

 

Description

This function checks whether Greylisting is enabled for the cPanel account.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/has_greylisting_enabled

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.
 
// Check whether the account's Greylisting is enabled.
$has_greylisting_enabled = $cpanel->uapi(
    'cPGreyList', 'has_greylisting_enabled'
);

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.
 
# Check whether the account's Greylisting is enabled.
my $has_greylisting_enabled = $cpliveapi->uapi(
    'cPGreyList', 'has_greylisting_enabled',
);

Note:

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

 cPanel Template Toolkit
<!-- Check whether the account's Greylisting is enabled. -->
[% execute('cPGreyList', 'has_greylisting_enabled',) %]

Note:

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

 Command Line
uapi --user=username cPGreyList has_greylisting_enabled

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": {
    
  },
  "data": {
    "enabled": 1
  }
}


Note:

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

Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample

enabled

Boolean

Whether Greylisting is enabled.

  • 1 — Enabled.
  • 0 — Disabled.
0