Skip to main content

How to manage custom, server-wide Exim filters in cPanel, and how to quickly enable and disable them in the WHM UI

Austin Lowery
  • Updated

Question

How to manage custom, server-wide Exim filters in cPanel, and how to quickly enable and disable them in the WHM UI?

 

Answer

This guide explains the cPanel specific steps for managing custom server wide filters for Exim.

This guide provides an example with basic logging, new header addition, and basic conditional syntax, but cPanel support is not able to provide support for the details of crafting custom filters to fit your specific needs. Please reach out to a systems administrator or review the documentation for those questions.

Before getting into the specifics of managing custom filters this introduction will also cover some basic concepts to help you understand if a custom Exim filter is the right solution for your situation. Please see the "Procedure" section below for cPanel specifics of managing filters.

Creating a New Filter
  1. Login to the server via SSH or Terminal as the root user.

  2. Create a new text file under the /usr/local/cpanel/etc/exim/sysfilter/options directory.

    # touch /usr/local/cpanel/etc/exim/sysfilter/options/FILTER

    Note: Keep in mind that the name of the file you create will be used in the WHM UI in later steps, so it is important to choose a filename that accurately represents what the filter should accomplish.

  3. Open the newly created file with the text editor of your choice, and add your filter configuration.
  4. Now that the filter is in place you can enable the new filter via WHM. Login to WHM as the root user.
  5. Navigate to Home / Service Configuration / Exim Configuration Manager
  6. Click on the grey Filters tab in the Exim Configuration Manager.

  7. Scroll to the bottom until you see the custom filter:

    Note: The yellow exclamation point indicates that a new option has been enabled, but Exim has not yet been restarted so the change is not yet in effect.

  8. Set the option for that filter to either On or Off.

  9. Click the blue Save button to rebuild the Exim configuration to include this new filter and restart Exim to read the newly built configuration.

    Warning: If there is a syntax or other problem with your new filter, Exim may fail to start properly. Pay close attention to the output provided on the next screen for any possible error messages.

Enabling or Disabling an Existing Custom Filter
  1. Login to WHM as the root user.
  2. Navigate to: Home / Service Configuration / Exim Configuration Manager
  3. Click on the grey Filters tab in the Exim Configuration Manager.
  4. Scroll to the bottom and look for the custom filter of interest.
  5. Set the option for that filter to either On or Off.
  6. Click the blue Save button to rebuild the Exim configuration and restart.

Related articles

Comments

0 comments

Article is closed for comments.

%