Description

This function deletes an email filter.


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



Examples 




$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.



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.


<cpanel Module="Email::delfilter( $FORM('email','dest') )">




cpapi1 --user=username Email delfilter user@example.com filter@example.com


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.