Child pages
  • cPanel API 2 Functions - Email::reorderfilters
Skip to end of metadata
Go to start of metadata

Description

This function modifies email filter order.

Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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:

  • 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. 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

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "reorderfilters",
    "data": [
      {
        "ok": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
mailboxstring

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

Returns

ReturnTypeDescriptionPossible valuesExample
okBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
1
resultBoolean

Whether the function succeeded.

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