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

 

Description

This function retrieves a .yaml.gz file that contains system-level filter information.

Examples 


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

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.
 
// Get a .yaml.gz file of the account's system-level filters.
$system_filters = $cpanel->uapi(
    'Email', 'list_system_filter_info'
);

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.
 
# Get a .yaml.gz file of the account's system-level filters.
my $system_filters = $cpliveapi->uapi(
    'Email', 'list_system_filter_info',
);

Note:

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

 

 cPanel Template Toolkit
<!-- Get a .yaml.gz file of the account's system-level filters. -->
[% execute( 'Email', 'list_system_filter_info' ) %]

Note:

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

 

 Command Line
uapi --user=username Email list_system_filter_info

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,
 "data":{
    "filter_info": "filter_info.username.yaml.gz"
  }
  "metadata": {
    "transformed": 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

ReturnTypeDescriptionPossible valuesExample
filter_infostringThe file that contains the account's system-level filter information.A .yaml.gz filename that contains the cPanel account username.
filter_info.username.yaml.gz