Child pages
  • cPanel API 2 Functions - Email::deletefilter

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

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

Warning
titleWarning:

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

  • Email::delete_filter

    Excerpt Include
    UAPI Functions - Email::delete_filter
    UAPI Functions - Email::delete_filter
    nopaneltrue

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

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

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Email deletefilter filtername=coffee
Note
titleNote:

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

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "deletefilter",
    "data": [
      {
        "filtername": "coffee",
        "deleted": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

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
filternamestring

Required

The filter name.

The name of a filter on the account.

coffee

Returns

ReturnTypeDescriptionPossible valuesExample
filternamestringThe filter's name.

The filtername input parameter's value.

coffee
deletedBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
1
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

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