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
Note:
Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
This function does not accept parameters.
Returns
Return |
Type |
Description |
Possible values |
Example |
filterinfo |
string |
The filter file's name. |
A valid filename. Generally, this value returns asfilter_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 areason value if it failed. |
A string that describes the error. |
This is an error message. |
result |
Boolean |
Whether the function succeeded. |
|
1 |