cPanel API 2 Functions - Email::filtername - Knowledgebase

Description

This function generates a name for a new email filter. When you call this function, it counts the existing email filters and returns a suggested rule name. For example, if you call this function for user@example.com, and user@example.com owns three existing filters, the function returns Rule 4.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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=filtername&account=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Generate a name for user@example.com's new mail filter,
// or call it Rule 1 if this is the first filter.
$name_my_filter = $cpanel->api2(
    'Email', 'filtername', 
    array(
        'account'      => 'user@example.com',
        'filtername'   => 'Rule 1',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Generate a name for user@example.com's new mail filter,
# or call it Rule 1 if this is the first filter.
my $name_my_filter = $cpliveapi->api2(
    'Email', 'filtername',
    {
        'account'      => 'user@example.com',
        'filtername'   => 'Rule 1',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

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

Command Line

cpapi2 --user=username Email filtername account=user%40example.com

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "filtername",
    "data": [
      {
        "filtername": Rule 9
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
account	string	The cPanel account name or email address for which the function counts filters. If you do not use this parameter, the function counts user-level filters.	The cPanel username. An email address on the cPanel account.	user@example.com
filtername	string	An alternate filter name, if the function cannot generate one. For example, the function returns this value in thefiltername return if the account address does not posses filters.	A string value.	Rule 9

Parameter

Type

Description

Possible values

Example

account

string

The cPanel account name or email address for which the function counts filters.

If you do not use this parameter, the function counts user-level filters.

The cPanel username.
An email address on the cPanel account.

user@example.com

filtername

string

An alternate filter name, if the function cannot generate one.

For example, the function returns this value in thefiltername return if the account address does not posses filters.

A string value.

Rule 9

Returns

Return	Type	Description	Possible values	Example
filtername	string	The suggested rule name.	A string value, in Rule * format, where * is the number of filters the account has, plus one. The filtername input value, if you supplied one and the function could not generate a name.	Rule 9
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Knowledgebase

Categories

Categories