How to preserve Exim system filter changes?

Question

How to preserve Exim system filter changes?

Answer

Sometimes, you must modify the Exim system filter that persists through cPanel updates. To prevent your Exim filter customizations from being overwritten during updates, you need to create a custom Exim system filter file to be included in the Exim configuration.

Note: Please note that cPanel rebuilds the /etc/cpanel_exim_system_filter file when the Exim configuration is updated, causing any customizations made to the file to be lost.

1. Access the server's command line as the 'root' user via SSH or "Terminal" in WHM.

2. Copy the contents of the cpanel_exim_system_filter file to a new file.

   # cp -p /etc/cpanel_exim_system_filter /etc/cpanel_system_filter_custom

   Warning: Do not use the following reserved filter names for your new filter file.

   • attachments
   • fail_spam_score_over_100
   • fail_spam_score_over_125
   • fail_spam_score_over_150
   • fail_spam_score_over_175
   • fail_spam_score_over_200
   • fail_spam_score_over_int
   • nullroot
   • spam_rewrite

3. Set the new file's permissions to 644.

   # chmod 644 /etc/cpanel_system_filter_custom

4. Open the new file in your preferred text editor.
5. Add the desired customizations.
6. Save the changes and exit the text editor.
7. Log in to WHM as the ‘root’ user.
8. Navigate to the Home / Service Configuration / Exim Configuration Manager
9. Click the "Basic Editor" tab.
10. Click the "Filters" tab.

11. Select the "System Filter File" textbox.

    Note: Please note that the Exim configuration will include all the files in the /usr/local/cpanel/etc/exim/sysfilter/options/ folder, even when using a custom filter file.

12. Enter the new file’s absolute path in the text box.

    # /etc/cpanel_system_filter_custom

13. Scroll to the bottom of the page.
14. Click the "Save" button.

Additional resources

Exim Internet Mailer: Chapter 3 - Exim filter files

How to Customize the Exim System Filter File