Child pages
  • cPanel API 2 Functions - Email::list_system_filter_info

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

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

Warning
titleWarning:

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

  • Email::list_system_filter_info

    Excerpt Include
    UAPI Functions - Email::list_system_filter_info
    UAPI Functions - Email::list_system_filter_info
    nopaneltrue

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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' 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Email list_system_filter_info

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "list_system_filter_info",
    "data": [
      {
        "filter_info": "filter_info.user.yaml.gz"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

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.

Note
titleNote:

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