cPanel API 2 Functions - Email::list_system_filter_info

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

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

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

Warning:

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

Email::list_system_filter_info — This function retrieves a .yaml.gz file that contains system-level filter information.

Examples

WHM API (JSON)

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

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

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

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 the account's filter file.
my $get_filter_file = $cpliveapi->api2(
    'Email', 'list_system_filter_info',
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Email list_system_filter_info

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username command.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

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

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 Type Description Possible values Example

Return	Type	Description	Possible values	Example
`filterinfo`	string	The 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`
`reason`	string	A reason for failure. Note: This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`

filterinfo

string

The 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

reason

string

A reason for failure.

Note:

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.

result

Boolean

Whether the function succeeded.

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

1