Description
This function deletes an email filter. For more information about Exim filters, read Exim's documentation.
Warning:
We strongly recommend that you use the following UAPI function instead of this function:
-
Email::delete_filter
— This function deletes an email filter.
Examples
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 |
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. |
|
user |
filtername |
string |
Required The filter name. |
The name of a filter on the account. |
coffee |
Returns
Return |
Type |
Description |
Possible values |
Example |
filtername |
string |
The filter's name. |
The filtername input parameter's value. |
coffee |
deleted |
Boolean |
Whether the function succeeded. |
|
1 |
reason |
string |
A reason for failure. Note: This function only returns areason value if it failed. |
A string that describes the error. |
This is an error message. |
result |
Boolean |
Whether the function succeeded. |
|
1 |