![]() |
Version 6.1 |
|||||||||||||||||||||||||||||||
|
|
System administrators can specify Server-Wide and Cluster-wide Message Rules. Use the WebAdmin Interface to open the Mail pages in the Settings realm, and click the Rules link.
System administrators can specify Account Rules using links on the Account Settings page.
Account users can specify their Rules themselves, using the WebUser Interface. System or Domain administrators can limit the set of Rule actions a user is allowed to specify.
System and Domain Administrators can specify Domain-Wide Rules using the Rules links on the Domain Settings page.
See the Automated Rules section to learn how to set the Rules.
Each Rule can use universal conditions specified in the Generic Rules section.
This section describes the additional Rule conditions you can use in E-mail (Queue) Rules.
Sample:
If a message has several addresses of the given type, the condition is met if it is true for at least one address. If a message has no addresses of the specified type, the condition is not met.
Sample:
Sample:
Sample:
Sample:
Sample:
It actually checks that the message header does not contain any of the following fields:
Precedence: bulk, Precedence: junk,
Precedence: list, X-List*,
X-Mirror*, X-Auto* (except for X-Auto-Response-Suppress),
X-Mailing-List, Auto-*
This condition also checks that the message has a non-empty Return-Path.
Sample:
The addresses are processed in the form they had before the Router Table and other routing methods have modified them. If an account has several aliases, this condition allows you to check if a message was sent to a specific account alias.
Messages can be submitted to the server using the ESMTP ORCPT parameter. This parameter specifies how the address was composed on the sending server, before the relaying/forwarding server has converted it to a different address. In this (rare) case, that server can use the ESMTP ORCPT parameter to specify the original address.
If the domain1.com server has not informed your server about the original address, the <user2@domain2.com> string is used when the Recipient condition is checked.
Sample:
SMIME:encrypted | if the message is encrypted using the S/MIME standard |
SMIME:signed | if the message is digitally signed using the binary S/MIME standard (PKCS7) |
signed | if the message is digitally signed |
(empty string) in all other cases |
Sample:
The following conditions can be used in Server-Wide Rules only:
The condition is met if it is met for at least one envelope recipient address.
The message address routing information is presented in the following format:
SMTP(domain)user@domain | if domain is a remote domain | |
LOCAL(user) | if domain is the Main Domain | |
LOCAL(user@domain) | if domain is a secondary CommuniGate Pro Domain |
Each Rule can have zero, one, or several actions. If a message meets all the Rule conditions, the Rule actions are performed.
You can use all universal actions described in the Generic Rules section. This section describes the additional Rule actions you can use in E-mail (Queue) Rules.
Sample:
Sample:
Sample:
If the mailbox name is specified as ~accountName/mailboxName, or as ~accountName@domainName/mailboxName the message is stored in the mailboxName Mailbox in the accountName Account in the same Domain or in the accountName@domainName Account.
When this action is used in a Server-wide or Cluster-wide Rule, the mailbox name must be specified in this form, as there is no default Account for those Rules.
Sample:
The header fields Subject: Re: original message subject and In-Reply-To: original message-ID are added to the reply message.
The specified message text can contain macro symbols that are substituted with actual data when a reply message is composed:
Sample:
If the specified text starts with the plus (+) symbol, the lines following this symbol are added to the message header. The text should specify the Subject field, since the system will not automatically add the Subject: Re: original subject and In-Reply-To: original message-ID fields into the reply message.
The specified header portion can contain additional To, Cc, and Bcc fields and the reply message will be sent to those addresses (the Bcc fields will be removed from the message header).
Unless the specified header contains the From field, the From field is composed using the From Address from the Account WebUser Settings. If that address is not set the From Address is composed using the full Account Name and the Account Real Name setting.
If the full Account name is not stored as the From field, it is stored as the Sender field.
The ^S and other macro symbols can be used in the additional header fields, too.
An empty line should separate the message body from the additional header fields:
If the specified text starts with the [charsetName] string, the text is converted to the specified charset (all non-ASCII texts are stored in the UTF-8 charset), otherwise it is converted into the charset used in the incoming message. If the incoming message did not have a charset specified, and the Rule is an Account-Level one, the Preferred Charset specified in the Account WebUser Preferences is used.
If the text starts with the plus symbol, the plus symbol must be specified after the [charsetName] string.
Unless the specified header contains the MIME-Version and Content-Type fields, these fields are added to the composed message.
The specified message header and the message body can contain macro symbols listed above.
The From, Sender,MIME-Version, and Content-Type fields are composed in the same way as for the Reply With operation.
Sample:
Sample:
Sample:
Sample:
A command text can be prefixed with the [FILE] tag:
Note: usually access to the base directory is not granted to regular users, so the [FILE] prefix can be used in the Server-Wide Rules only.
A command text can be prefixed with the [RETPATH] tag:
A command text can be prefixed with the [RCPT] tag:
A command text can be prefixed with the [ORCPT] tag:
Note: the [RCPT] and [ORCPT] prefixes cannot be used together.
A command text in an Account-Level Rule can be prefixed with the [ACCNT] tag:
A command text in a Server-Wide Rule can be prefixed with the [ROUTE] tag:
A command text can be prefixed with the [STDERR] tag (see below).
A command text can have several prefix strings, and they can be specified in any order. If several of [FILE], [RETPATH], and [RCPT] prefix strings are specified, the -f flag and its parameter are added first, followed with the -p flag and its parameter, followed with the -r flag and its parameters.
When the task completes, the task exit code is checked. If the code is zero, the Rule action is considered as executed successfully, and the next Rule action is executed.
If the task exit code is non-zero, the message is rejected with the error code
"automated processing failed", and the data from the task
standard error channel is recorded in the Log along with the task exit code.
If the [STDERR] prefix was specified on the command line, the data
written to the standard error channel (if any) is used to compose the error report text.
The data from the task standard output, if any, should not exceed 4Kbytes in size. It is recorded in the Log and discarded.
The CommuniGate Pro Server monitors the task during its execution, and it interrupts the task if it does not complete within 2 minutes.
When a task is to be executed as a part of Account-Level Rule processing, the OS User Name is composed using the Account OS User Name setting, and the task is executed in that OS User Environment.
Sample:
Sample:
Parameter strings for some actions can include "macro" - symbol combinations that are substituted with actual data before the parameter is used with the Rule action.
The following symbol combinations are available:
Each Account can have a "simplified" Rule to generate Vacation messages. When enabled, the Rule checks that the message is not an auto-generated one, and that the message author (the 'From' address) has not be placed into the RepliedAddresses string list. It then composes and sends an Vacation message and adds the message author address into the RepliedAddresses string list, so the Vacation message will be sent to each message author only once. Alternatively, the Notify option may be enabled, so a copy of each incoming message is forwarded to the specified addresses.
This Rule conditions are:The Rule actions are:
Only the text of the Reply message can be modified:
Even if the Administrator has not allowed the user to specify Automated Rules, the Vacation Message can be enabled by the user herself, and the user can always modify the Vacation Message text.
If "Clear 'Replied Addresses' List" button is clicked, the RepliedAddresses string list is removed from the Account dataset. Alternatively, the Enable Vacation Message button can be present. It enables the Vacation Rule and clears the Replied Addresses list at the same time.
An Account can use a simplified Rule to redirect all incoming E-mail messages to a different address or addresses.
This Rule condition is either empty (the Rule action is applied to all messages) or, optionally, human generated, the Rule actions are Redirect To or Mirror To, and, optionally, Discard.
Only the list of redirection addresses can be modified:
An Account can have simplified Rules to handle junk E-mail messages.
These Rules rely on other Rules, usually employing External Filter programs, to add a special message headers field with the "junk probability" level.
Each Junk Control Rule has a condition checking contents on the X-Junk-Score message header field. The other condition checks if the message From address is not included into the AddressBook dataset ("whitelisting").
If the conditions are met, a Junk Control Rule can either discard the E-mail message, store it in the Junk Mailbox (the Junk Mailbox name as specified using the Account Preferences), or mark the stored E-mail Message with the Junk flag.
The Enqueuer component records Server-Wide Rules activity in the Log.
Set the Enqueuer Log Level to Low-Level or All Info to see the Rules checked and the actions executed.
The Local Delivery module records Domain-Wide and Account-Level Rules activity in the Log.
Set the Local Delivery module Log Level to Low-Level or All Info to see the Rules checked and the actions executed.