cPanel API 2 Functions - Email::filtername

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

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

Warning:

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

Important:

When you disable the Receive Mail role, the system disables this function.

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="user@example.com"&filtername="Rule%201"

Note:

For more information, read our Calls from the WHM API documentation.

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

Note:

For more information, read our Guide to the LiveAPI System.

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',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

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

Command Line

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

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username command.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

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

Note:

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

Parameters

Parameter Type Description Possible values Example

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 the `filtername` return if the `account` address does not posses filters.	A string value.	`Rule 9`

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 the filtername 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 `reason` value 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`