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

Versions Compared

Key

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

Description

Excerpt

This function disables a filter.


Warning
titleWarning:

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

  • Email::disable_filter

    Excerpt Include
    DD:UAPI Functions - Email::disable_filterDD:
    UAPI Functions - Email::disable_filter
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

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=disablefilter&account="user@example.com"&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.
 
// Disable user@example.com's mail filter.
$kill_filter = $cpanel->api2(
    'Email', 'disablefilter', 
    array(
        'account'                => 'user@example.com', 
        '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.
 
# Disable user@example.com's mail filter.
my $kill_filter = $cpliveapi->api2(
    'Email', 'disablefilter',
    { 
        'account'                => 'user@example.com', 
        '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 disablefilter 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": "disablefilter",
    "data": [
      {
        "filtername": "coffee",
        "updated": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

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

Note
titleNote:

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
filternamestring

Required

The filter name.

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

Returns

ReturnTypeDescriptionPossible valuesExample
errorstring

An error message.

Note
titleNote:

This function only returns the error parameter if the function 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