cPanel API 2 Functions - Email::disablefilter - Knowledgebase

Description

This function disables a filter.

Warning:

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

Email::disable_filter — This function disables an email filter.

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=disablefilter&account=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Disable user@example.com's mail filter.
$kill_filter = $cpanel->api2(
    'Email', 'disablefilter', 
    array(
        'account'                => 'user@example.com', 
        'filtername'             => 'coffee',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Disable user@example.com's mail filter.
my $kill_filter = $cpliveapi->api2(
    'Email', 'disablefilter',
    {
        'account'                => 'user@example.com',
        'filtername'             => 'coffee',
    }
);

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "disablefilter",
    "data": [
      {
        "filtername": "coffee",
        "updated": 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
account	string	The filter's email address or the cPanel account username. Note: If you do not use this parameter, the function disables an account-level filter.	A valid email address on the cPanel account, to disable that account's user-level filter. The cPanel account username, to disable the account's main email address's user-level filter.	user@example.com
filtername	string	Required The filter name.	The name of a user-level or account-level filter.	coffee

Parameter

Type

Description

Possible values

Example

account

string

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

Note:

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

A valid email address on the cPanel account, to disable that account's user-level filter.
The cPanel account username, to disable the account's main email address's user-level filter.

user@example.com

filtername

string

Required

The filter name.

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

coffee

Returns

Return	Type	Description	Possible values	Example
error	string	An error message. Note: This function only returns theerror parameter if the function failed.	A message that describes the error.	No filter named "filtername" exists.
filtername	string	The 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
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories