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

 

Description

This function disables an email filter.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/disable_filter?account=user%40example.com&filtername=coffee

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Disable user@example.com's coffee filter.
$filter_disable = $cpanel->uapi(
    'Email', 'disable_filter',
    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.
 
# Disable user@example.com's coffee filter.
my $filter_disable = $cpliveapi->uapi(
    'Email', 'disable_filter',
    {
        'account'     => 'user@example.com',
        'filtername'  => 'coffee',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Disable user@example.com's coffee filter. -->
[% execute('Email', 'disable_filter', { 'account' => 'user@example.com', 'filtername' => 'coffee', }) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email disable_filter account=user%40example.com filtername=coffee

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "filtername": "coffee",
    "updated": 1
  },
  "metadata": {
    "transformed": 1
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The email address that owns the filter.

A valid email address on the cPanel account.

user@example.com
filternamestring

Required

The filter's name.

The name of an email filter.coffee

Returns

ReturnTypeDescriptionPossible valuesExample
filternamestringThe filter's name.The filtername input parameter's value.coffee
updatedBooleanWhether the function updated the filter.
  • 1 — Updated,
  • 0 — Did not update.
1