Description

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

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Email/list_system_filter_info



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

 



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

 



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

 



uapi --user=username Email list_system_filter_info



{
  "messages": null,
  "errors": null,
  "status": 1,
 "data":{
    "filter_info": "filter_info.username.yaml.gz"
  }
  "metadata": {
    "transformed": 1
  }
}



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