Child pages
  • UAPI Functions - cPGreyList::has_greylisting_enabled

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titlecPanel or Webmail Session URL
Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/has_greylisting_enabled

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Template Toolkit
Code Block
languagexml
linenumberstrue
<!-- Check whether the account's Greylisting is enabled. -->
[% execute('cPGreyList', 'has_greylisting_enabled',) %]

Include Page
LIB:_TTLink
LIB:_TTLink

Expand
titleCommand Line
Code Block
languagetext
uapi --user=username cPGreyList has_greylisting_enabled

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": {
    "enabled": 1
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

This function does not accept parameters.

Returns

Return

TypeDescriptionPossible valuesExample

enabled

Boolean

Whether Greylisting is enabled.

  • 1 — Enabled.
  • 0 — Disabled.
0