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

Description

This function deletes an email filter.

Note:

You cannot run this function In cPanel & WHM version 70 or later. The function will fail and it may not provide an error message.

Warnings:

  • We removed this function in cPanel & WHM version 70.
  • cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:
    • UAPI (recommended)Email::delete_filter
      Error rendering macro 'excerpt-include' : No link could be created for 'UAPI Functions - Email::delete_filter'.
    • cPanel API 2Email::deletefilter
      Error rendering macro 'excerpt-include' : No link could be created for 'cPanel API 2 Functions - Email::deletefilter'.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$del_email_filter = $cpanel->api1('Email', 'delfilter', array('user@example.com', 'filtered@example.com') ); // Call the function.

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.
my $del_email_filter = $cpliveapi->api1('Email', 'delfilter', ['user@example.com', 'filtered@example.com'] ); # Call the function.

Note:

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

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::delfilter( $FORM('email','dest') )">
 Command Line
cpapi1 --user=username Email delfilter user@example.com filter@example.com

Notes:

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

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
email

string

Required

The email address for which to remove a filter.

A valid email address on the server.user@example.com
deststring

Required

The destination to which the system sends email messages that match the filter's criteria.

  • Any valid email address.
  • Discard
  • A pipe to a shell application.
filtered@example.com

Returns

This function does not return output.