Mail Filtering with Procmail

Procmail is an open-source mail processor, also known as "mail filter" that helps filtering your mail and sort incoming mail according to sender, subject line, length of message, keywords in the message, etc.

To set Procmail, you need to log into CP+ by typing in http://cp_host_domain:20000/ in your browser with the domain account's login and password:

On the domain user's CP+ menu, click the Procmail Mail Filter icon . You will see the following five options that allow to:

- Add a new filter action: use this option to set delivery action details and conditions.
- Add a new conditional block: use this option if you want to a new condition to delivery action.
- Add a new variable setting: use this option to create a custom Procmail variable setting.
- Add a new include file: use this option to include the a set of procmail rulesets.
- Manually edit configuration: use this option to manually edit the Procmail configuration file /home/example/.procmailrc.

 Adding a new filter action

1. Click Add a new filter action on the Procmail Mail Filter page. You will see the following page:



2. Choose the delivery action to be taken from the drop-down box. Enter details of this target action in the field.
3. Set necessary delivery method by checking the corresponding boxes.
4. Set Delivery lock file, optionally.
5. Choose Action conditions from the drop-down box and use the field to set details of this conditions.
6. Click Create to preserve this filter rule.

From now on all your messages will be filtered according to the filter method you have set.

To change filter action settings, click the name of the action and make sure to save all changes when done

 Adding a new conditional block

1. Click Add a new conditional block on the Procmail Mail Filter page. You will see the following page:



2. Enter Procmail code to execute according to requirements of Procmail.
3. Set necessary delivery method by checking the corresponding boxes.
4. Set Delivery lock file, optionally.
5. Choose Action conditions from the drop-down box and use the field to set details of this conditions.
6. Click Create to save this conditional block.

To change or edit conditional block, click the block name in the Action to take section and make sure to save all changes when done

 Adding a new variable setting

1. Click Add a new variable setting on the Procmail Mail Filter page. You will see the following form:



2. Enter variable name and value.
3. Click Create to save this variable setting.

To change or edit variable setting, click the variable in the Actions list and make sure to save all changes when done

 Adding a new include file

1. Click Add a new variable setting on the Procmail Mail Filter page. You will see the following form:



2. Enter file location or find file using the browse button.
3. Click Create to save this included file.

To change location of the include file, click the file in the Actions list and make sure to save all changes when done.

 Editing configuration manually

This page can be used to manually edit the Procmail configuration file /home/example/.procmailrc. Be careful, as no syntax checking will be done.

1. Click Add a new variable setting on the Procmail Mail Filter page.
2. On the page that shows edit Procmail configuration.
3. Click Save.