Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function enables a filter.

Warning:

We strongly recommend that you use the following UAPI function instead of 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=enablefilter&account="user@example.com"&filtername="coffee"

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.
 
// Enable user@example.com's mail filter.
$enable_filter = $cpanel->api2(
    'Email', 'enablefilter', 
    array(
        'account'                => 'user@example.com', 
        'filtername'             => 'coffee',
    ) 
);

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.
 
# Enable user@example.com's mail filter.
my $enable_filter = $cpliveapi->api2(
    'Email', 'enablefilter',
    { 
        'account'                => 'user@example.com', 
        'filtername'             => 'coffee',
    }
);

Note:

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

 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 enablefilter filtername=coffee

Note:

For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.  

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "enablefilter",
    "data": [
      {
        "filtername": "coffee",
        "updated": 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
accountstring

The filter's email address or the cPanel account username.

Note:

If you do not use this parameter, the function enables an account-level filter. 

  • A valid email address on the cPanel account, to enable that account's user-level filter.
  • The cPanel account username, to enable the account's main email address's user-level filter.
user@example.com
filternamestring

Required

The filter name.

The name of a user-level or account-level filter.coffee

Returns

ReturnTypeDescriptionPossible valuesExample
errorstring

An error message.

Note:

The function only returns an error value if it failed.

A message that describes the error.No filter named "filtername" exists.
filternamestringThe filter's name.

The filtername input parameter's value.

coffee

updated

Boolean

Whether 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