cPanel API 2 Functions - Email::reorderfilters

Warning:

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

Description

This function modifies email filter order.

Warning:

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

Email::reorder_filters — This function modifies the filter order for an email address.

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=reorderfilters&mailbox=user@example.com&filter1=coffee&filter2=cheesecloth

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.

// Modify filter order for user@example.com's mail filters.
$change_filter_order = $cpanel->api2(
    'Email', 'reorderfilters',
    array(
        'mailbox'         => 'user@example.com',
        'filter1'         => 'coffee',
        'filter2'         => 'cheesecloth',
    )
);

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.

# Modify filter order for user@example.com's mail filters.
my $change_filter_order = $cpliveapi->api2(
    'Email', 'reorderfilters',
    {
        'mailbox'         => 'user@example.com',
        'filter1'         => 'coffee',
        'filter2'         => 'cheesecloth',
    }
);

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 reorderfilters mailbox=user%40example.com filter1=coffee filter2=cheesecloth

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
```

Parameters

Parameter	Type	Description	Possible values	Example
`mailbox`	string	Required The email address.	A valid email address on the account.	`user@example.com`
`filter*`	string	Required A mail filter. Note: For each mail filter to reorder, supply a `filter` parameter, where `` represents a number that represents the filter's order. For example, to set `coffee` as the first email filter and `cheesecloth` as the second, set `coffee` as the `filter1` parameter's value, and `cheesecloth` as the `filter2` parameter's value.	The name of one of the email address's filters.	`coffee`

mailbox

string

Required

The email address.

A valid email address on the account.

user@example.com

filter*

string

Required

A mail filter.

Note:

For each mail filter to reorder, supply a filter* parameter, where * represents a number that represents the filter's order.

For example, to set coffee as the first email filter and cheesecloth as the second, set coffee as the filter1 parameter's value, and cheesecloth as the filter2 parameter's value.

The name of one of the email address's filters.

coffee

Return	Type	Description	Possible values	Example
`ok`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`

ok

Boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

1

result

Boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

1

cPanel API 2 Functions - Email::reorderfilters

Description

Examples

Parameters

Returns