cPanel API 2 Functions - Email::deletefilter

Description

This function deletes an email filter. For more information about Exim filters, read Exim's documentation.

Warning:

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

  • Email::delete_filter — This function deletes 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=deletefilter&filtername=coffee

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete an email filter.
$delete_mail_filter $cpanel->api2(
    'Email''deletefilter'
    array(
        'filtername'      => 'coffee',
    
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete an email filter.
my $delete_mail_filter $cpliveapi->api2(
    'Email''deletefilter',
    {
        '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 deletefilter filtername=coffee

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "deletefilter",
    "data": [
      {
        "filtername": "coffee",
        "deleted": 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 cPanel account name or email address, to delete a user-level filter.

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

  • The cPanel username.
  • A user-level filter's email address. 

 user

 filtername

 string

 Required

 The filter name.

 The name of a filter on the account.

 coffee

  

Returns

Return

Type

Description

Possible values

Example

 filtername 

 string

 The filter's name.

 The filtername input parameter's value. 

 coffee

 deleted

 Boolean 

 Whether the function succeeded.

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

 1

 reason

 string

 A reason for failure.

 Note:

 This function only returns areason value if it failed. 

 A string that describes the error.

 This is an error message. 

 result

 Boolean

 Whether the function succeeded.

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

 1

 

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....