Rules

This dialog is the same for all accounts and domains.

Selecting Mail Service –> Filters –> Rules or the Rules tab with a domain or user selected gives you access to the Rules list, allowing you to perform maintenance on the rules.

rules_tab

Field	Description
Active	Tick the box to activate this feature.
Add	Click the button to add a new rule. The Rule dialog opens.
Edit	Click the button to modify an existing rule. The Rule dialog opens.
Delete	Click the button to delete the selected rule.
Up/down arrows	Click the appropriate arrow to move the selected rule up or down.
Edit File	Click the button to open the file that contains defined rules. You can edit rules here. NOTE: The filter is a text file with a strictly defined format. The file can be edited directly using a standard text file editor but we highly recommend that you use the Add, Edit and Delete buttons as even the simplest mistake can cause valid emails to be rejected.
"B" button	Click the button to open the Bypass dialog where you can define items that will bypass defined rules.
Select/deselect all	Use this feature to ease operations with more rules.

Multiple rules can be selected for deletion by holding the Ctrl key and clicking multiple rules.

A range of rules can be selected by clicking the first rule of the range and then clicking the last one while holding down the Shift key.

NOTE: Rules can be activated and de-activated by checking/un-checking the box to the left of the rule. This is useful for testing purposes or to disable a rule for a time without deleting it.

Rules-RuleBuilder

Field	Description
Conditions	In this area, you can select the properties of the message that you wish to perform some test on. Multiple conditions can be tested by checking multiple boxes. The same condition can be added multiple times by double clicking the Condition when it is checked.
Actions	In this area, you select the action(s) that you want to perform on the message if the rule evaluates as True. Multiple actions can be selected by checking multiple boxes.
Logic buttons	The buttons below the Actions block are used to add logic to the rule The Exclamation mark will negate (NOT) the Condition you are currently modifying. The up and down arrows will move the conditions up and down within the rule. The X button will delete the current Condition. We recommend experimentation with these buttons to familiarize yourself with their function.
Description	This will show the rule you are building or modifying and will change dynamically as you select or de-select conditions and actions. Areas of the rules that can be modified are highlighted in this block and clicking them opens a further dialog box to allow you to define your test.
Title	The name of the rule, for identification purposes.

The following table details individual conditions and actions.

Condition	Description
Where From: message header matches some words	Check the From: header for a string Condition. In the rule description click on some words to create the string condition (explained below).
Where To: message header matches some words	Check the To: header for a string Condition. In the rule description click on some words to create the string condition (explained below).
Where Subject: message header matches some words	Check the Subject: header for a string Condition. In the rule description click on some words to create the string condition (explained below).
Where Cc: message header matches some words	Check the Cc: header for a string Condition. In the rule description click on some words to create the string condition (explained below).
Where Reply-To: message header matches some words	Check the Reply-To: header for a string Condition. In the rule description click on some words to create the string condition (explained below).
Where Date: message header matches some words	Check the Date: header for a string Condition. In the rule description click on some words to create the string condition (explained below).
Where Message priority is value	Check the priority of a message. Click on Normal in the Rule description to select a priority.
Where Message is spam	Check if the message has been marked as spam.
Where Message is size	Check the Message size. Click the 0 kB to select the message size criteria. Select Greater or Lower and specify a Size (in kB)
Where Message body matches some words	Check the message body for a string condition. In the rule description click on some words to create the string condition (explained below). NOTE: Use this option with care as scanning the whole message body of every incoming message could seriously affect your Server performance.
Where Custom message header matches some words	Check a Custom message Header for a string condition. In the rule description click on some words to create the string condition (explained below). NOTE: This rule has an unusual format for the string condition! format - <header>:<string condition> where <header> is the name of your custom header <string condition> is the string condition to test for. Example MyHeader:jim;bob;john Would check the header "MyHeader" for any of the strings "jim", "bob" or "john".
Where Any message header matches some words	Check all headers for a string condition. In the rule description click on some words to create the string condition (explained below).
Where Attachment name matches some words	Check the Attachment name for a string condition. In the rule description click on some words to create the string condition (explained below).
Where message contains attachment	Check whether the message has an attachment.
Where Sender matches some words	Check the Sender for a string condition. In the rule description click on some words to create the string condition (explained below).
Where Recipient matches some words	Check the Recipient for a string condition. In the rule description click on some words to create the string condition (explained below).
Where sender/recipient is local/remote	Check the location of the sender or recipient. In the rule description click on local/remote to open the following dialog: Sender / Recipient Select whether you want to check the the Sender or Recipient address Local / Remote Select whether you want whether the chosen address is a Local account or a Remote account. Ignore / Account exists / Account does not exist select whether you want to check whether the account exists, doesn't exist, or ignore this check. Only available for Local accounts. Member of: Check whether the account belongs to a particular Domain, Group, Mailing List, etc.. Press the '...' button to open the standard Select Item dialog. Only available for local accounts that you check the existence or non-existence of.
Where Sender's IP address matches some words	Check the Remote IP address for a string condition. In the rule description click on some words to create the string condition (explained below).
Where rDNS (PTR) matches some words	Check the rDNS (PTR) record for a string condition. In the rule description click on some words to create the string condition (explained below).
Where Sender's IP address is trusted	Check if the Senders IP address is in the trusted list.
Where Spam score is value	Click on 0.0 in the Rule description to define a greater than or less than value to check the spam score against.
Where SMTP AUTH	Check if this message was delivered using an SMTP Authorized connection.
All messages	A special condition that evaluates TRUE for all messages - use with care!

String Testing	Description
	Clicking on some words (in a new condition) or the string itself (in a condition already defined) will open the String Condition dialog box. There are four options available in the dialog: The Function drop-down box offers 7 options for the string test, the option chosen effects the content required in the String text-box
Contains list of strings (semi-colon separated)	Populate the String box with a list of strings to test for
Regex	Populate the String box with a regular expression. There is a basic Regex tutorial here
Starts with string	Looks for the string specified in the String box at the start of the tested condition
Ends with string	Looks for the string specified in the String box at the end of the tested condition
Is string	Tests whether the tested condition is exactly equal to the string specified in the String box
Contains list of strings from file	The String box should contain the path to a text file containing a list of strings you wish to test for. Press the "..." button to open a file dialog to navigate to a file where you can specify strings, one per line.
Match case	Check this box to take string case into account.
Match whole word only	Check this box to perform a standard "whole word" check against the string.
Actions	Description
	The following Actions are available when a Condition is evaluated TRUE. Multiple Actions can be selected by checking multiple boxes. Selecting an Action will add the Action to the Description box and for some Actions you are able to click the text in the description to define the Action further. Details follow:
Reject/Accept/Delete/Spam message	Adds an Action to Reject (default) the message. Click on Reject in the Description area to select Reject, Accept, Delete, or mark the message as Spam.
Stop processing more rules	Stop any further Rules from being processed, if this Rule is evaluated as TRUE.
Forward to email address	Forward the message to an email address. Click email address in the Description area to specify the email address. NOTE: You can also send an instant message or an sms using this option: sms - use sms:<number> e.g. sms:0123456789 IM - use xmpp:<jabberid> e.g. bruce@icewarpdemo.com
Move to folder	Move the message to a folder. Click on folder in the Description area to select the folder to move to. NOTE: The folder tree does not fill when you access this Action within Content Filters, you have to manually specify a mailbox. ALSO: although the INBOX folder may be shown in the folder tree, there is little point selecting this folder as this is the default folder that messages will come in to. ALSO: You can have email delivered to a specific mailbox folder by specifying %%Extension%% as the folder name. When this is specified IceWarp Server will look for a folder name within the email address and store the message to that folder if it exists. Example: A message sent to john:%%important%%@icewarpdemo.com will be stored in the folder important Note the colon used to separate the User alias from the folder name, this can be changed to another character using the API.
Copy to Folder	Copy the message to a folder. Click on folder in the Description area to select the folder to copy to. For description of the selection dialog, refer to the Content Filters – Filter Action chapter. NOTE: Although the INBOX folder may be shown in the folder tree, there is little point selecting this folder as this is the default folder that messages will come in to.
Encrypt message	Check this option to have the message encrypted. NOTE: For this option to work there must be a copy of the user's public certificate located in a file called cert.pem in the user's mailbox folder. The message will be encrypted using this certificate and then can only be decrypted by the user using his private key in his email client.
Send message	Send a message. Click message in the Description area to open a dialog to define the message. You can define To, From and Subject fields, the Text of the message (or a file to retrieve the text from), the type of message (text, HTML, or message with attachment) and whether the message is email, an instant message, or both.
Edit message header	Select this option to Add, Edit or Delete a message header. Click on header to open the Edit Message Headers dialog. Click Add to add a new rule. Select an already defined rule and click Edit or Delete to modify or remove a rule. In the Action drop-down you should select whether this rule will add/edit a header or delete it. In the Header field you should specify the header you want to change/add – remember that the last header name character have to be a colon. You can also add your own named headers e.g. MyHeader: The first rule shown in the screenshot above modifies the From header - it adds the string "[URGENT]" to the start of the header. Note the use of the IceWarp Server system variable %%from%% here, which is the value of the original From header. Any system variable can be used. The second rule simply deletes the From header.
Set message priority to value	Select this option to have the priority of the message changed. Click the Normal to select the new priority to be assigned.
Set message flag	Select this option to set a message flag. Click on flags to set the flag(s) you wish.