UAPI Functions - Email::enable_filter - Knowledgebase

Description

This function enables an email filter.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/enable_filter?account=user%40example.com&filtername=coffee

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Enable user@example.com's coffee filter.
$filter_enable = $cpanel->uapi(
    'Email', 'enable_filter',
    array(
        'account'     => 'user@example.com',
        'filtername'  => 'coffee',
         )
);

 LiveAPI Perl Module

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

cPanel Template Toolkit

[% execute('Email', 'enable_filter', { 'account' => 'user@example.com', 'filtername' => 'coffee', }) %]

Command Line

uapi --user=username Email enable_filter account=user%40example.com filtername=coffee

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

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	Required The email address that owns the filter.	A valid email address on the cPanel account.	user@example.com
filtername	string	Required The filter's name.	The name of an email filter.	coffee

Parameter

Type

Description

Possible values

Example

account

string

Required

The email address that owns the filter.

A valid email address on the cPanel account.

user@example.com

filtername

string

Required

The filter's name.

The name of an email filter.

coffee

Returns

Return	Type	Description	Possible values	Example
filtername	string	The filter's name.	The filtername input parameter's value.	coffee
updated	Boolean	Whether the function updated the filter.	1 — Updated. 0 — Did not update.	1

Knowledgebase

Categories

Categories