Description

This function adds an account-wide email filter.


  • We removed this function in cPanel & WHM version 70. 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.
$new_email_filter = $cpanel->api1('Email', 'addfilter', array('This email is filtered.', 'contains', 'message_body', 'filtered@example.com') ); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $new_email_filter = $cpliveapi->api1('Email', 'addfilter', ['This email is filtered.', 'contains', 'message_body', 'filtered@example.com'] ); # Call the function.

 


<cpanel Module="Email::addfilter( $FORM('match value','method','msgpart','dest') )">




cpapi1 --user=username Email addfilter match "This email is filtered." contains message_body filtered@example.com


This function does not return output.



Parameters

ParameterTypeDescriptionPossible valuesExample
match value

string

or

integer

Required

The value for which to search.

Any valid string or integer.This email is filtered.
methodstring

Required

The matching type.

  • If the match value parameter is an integer, use a numeric operator.
  • If the match value parameter is not an integer, use a string operator.

Numeric operators:

  • is above
  • is not above
  • is below
  • is not below
  • equals

String operators:

  • contains
  • begins
contains
msgpartstring

Required

The email message section to search.

  • header_from
  • header_subject
  • header_to
  • reply_address
  • message_body
  • message_headers
  • h_to
  • h_cc  
  • not delivered
  • error_message
  • h_X-Spam-Status
  • h_X-Spam-Score
  • h_X-Spam-Bar
message_body
deststring

Required

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

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

Returns

This function does not return output.