cPanel API 2 Functions - Email::reorderfilters - Knowledgebase

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.

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

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

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

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

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "reorderfilters",
    "data": [
      {
        "ok": 1
      }
    ],
    "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
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 filterparameter, 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 thefilter1 parameter's value, and cheesecloth as the filter2 parameter's value.	The name of one of the email address's filters.	coffee

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 thefilter1 parameter's value, and cheesecloth as the filter2 parameter's value.

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

coffee

Returns

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

Knowledgebase

Categories

Categories