Description

This function retrieves the name of the email account's filter file.

 For more information about Exim filters, read Exim's documentation.

We strongly recommend that you use the following UAPI function instead of this function:

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=list_system_filter_info

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get the account's filter file.
$get_filter_file = $cpanel->api2(
    'Email', 'list_system_filter_info' 
);

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get the account's filter file.
my $get_filter_file = $cpliveapi->api2(
    'Email', 'list_system_filter_info',
);

cpapi2 --user=username Email list_system_filter_info

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "list_system_filter_info",
    "data": [
      {
        "filter_info": "filter_info.user.yaml.gz"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
filterinfostringThe filter file's name.

A valid filename.

Generally, this value returns as filter_info, a dot (.), the cPanel username, and the .yaml.gz file extension.

filter_info.user.yaml.gz
reasonstring

A reason for failure.

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1