Description
This function deletes an email filter.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/delete_filter?account=user%40example.com&filtername=coffee
LiveAPI PHP Class
$cpanel = new CPANEL();
$kill_filter = $cpanel->uapi(
'Email', 'delete_filter',
array(
'account' => 'user@example.com',
'filtername' => 'coffee',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $kill_filter = $cpliveapi->uapi(
'Email', 'delete_filter',
{
'account' => 'user@example.com',
'filtername' => 'coffee',
}
);
cPanel Template Toolkit
[% execute('Email', 'delete_filter', { 'account' => 'user@example.com', 'filtername' => 'coffee' }) %]
|
Command Line
uapi --user=username Email delete_filter account=user@example.com filtername=coffee
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": null,
"metadata": {
"transformed": 1
}
}
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
|
Returns
This function only returns metadata.
