UAPI Functions - Email::list_system_filter_info - Knowledgebase

Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

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

);

LiveAPI Perl Module

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

);

cPanel Template Toolkit

[% execute( 'Email', 'list_system_filter_info' ) %]

Command Line

uapi --user=username Email list_system_filter_info

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

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
filter_info	string	The 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

Knowledgebase

Categories

Categories