UAPI Functions - Email::list_filters_backups - Knowledgebase

Description

This function lists all of the cPanel account's domains that use domain-level filters.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List all of the the domains with domain-level filters.

$filtered_domains = $cpanel->uapi(

'Email', 'list_filters_backups'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List all of the the domains with domain-level filters.

my $filtered_domains = $cpliveapi->uapi(

'Email', 'list_filters_backups',

);

cPanel Template Toolkit

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

Command Line

uapi --user=username Email list_filters_backups

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
 "data":[ 
      { 
         "domain":"example.com"
      },
      { 
         "domain":"addondomain.com"
      },
      { 
         "domain":"seconddomain.com"
      }
   ]
  "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
data	array of hashes	An array of hashes that contains information about domains with domain-level filters.	This array of hashes includes the domain return.
domain	string	A domain with a domain-level filter. The function returns this value in the data hash.	A valid domain on the cPanel account.	example.com

Return

Type

Description

Possible values

Example

data

array of hashes

An array of hashes that contains information about domains with domain-level filters.

This array of hashes includes the domain return.

domain

string

A domain with a domain-level filter.

The function returns this value in the data hash.

A valid domain on the cPanel account.

example.com

Knowledgebase

Categories

Categories