MailEnable Enterprise Guide
Message Filtering / Global Filtering / Filter actions
In This Topic
    Filter actions
    In This Topic

    A filter action is an event that occurs when a filter criteria is met. 

    How to add a Filter Action

    1. Navigate within the administration console to the following location: MailEnable Management > Messaging Manager > Filters
    2. Double click on a Filter within the right hand pane filter list.
    3. In the Filter management window click on the Add Action... button
    4. Select the desired action and then click Close

    Actions are performed in a prioritized list - first to last. To move a particular action in the list to a desired position, highlight the action to move and use the up and down arrows located to the right of the actions list.

    The following is a description of the possible actions that can be performed when criteria is met.

    Copy to BadMail

    A copy of the message is sent to the Bad Mail folder. The message will still be delivered to the destination mailbox as well. To send to bad mail, and not deliver to the mailbox, create a Delete Message action to occur after the Copy to BadMail.

    Copy to Quarantine

    Copies the message to the Quarantine folder. The quarantine folder is global area that filters can place email messages so they can be viewed or processed later by an administrator.

    Delete Message

    Deletes the message.

    Notify Sender

    This action will send a notification message to the sender of the message. The message filter allows system tokens to be inserted into notification message templates. When defining an action to notify a user with a message, a message template for the notification can then be specified.

    The following table lists the tokens that can be used in message templates when constructing a notification message. Tokens are populated based on the criteria of the filter. For example, criteria for a filter that was specified to scan for viruses, only the “All” tokens and “Antivirus” tokens would be available within the notification template.

    Token Name


    Applicable criteria


    Contains the name of the filter that executed the call



    The description of the current action that



    The system filename of the message



    The system connector associated with the message



    The originating IP Address of the message



    The account or post office “owning the message”



    The sender of the message



    The antivirus agent return value

    Antivirus Scanning


    The action performed by the antivirus agent when scanning

    Antivirus Scanning


    The system name of the antivirus agent that was used to scan the message

    Antivirus Scanning


    The system BadMail Sender as defined under the SMTP connectors properties



    A system generated MessageID appropriate for the MessageID header



    The RFC 822 headers of the original message



    The size of the original message

    Message Size Criteria


    The size limit of the original message

    Message Size Criteria


    The Bayesian filtering value resulting from the message

    Spam Probability


    The Bayesian filtering threshold for the message

    Spam Probability

    Notify Recipient

    Sends a notification email to the recipient to inform them that an action has occurred on an inbound email. For example, if a message is deleted because an attachment is an executable, this option will notify the recipient that this has happened.

    The same notification options as outlined can be used when performing the Notify Sender action (see table above).

    Notify Address

    This will send a notification message to a specified email address.

    Forward to Address

    This filter action creates a copy of the email and forwards it to an email address. The original message will not be deleted.

    Execute Application

    Execute an application on the email. Since the MTA may execute this external application concurrently, make sure that the application specified can have multiple instances running. If not, a workaround would be to change the MTA service to only use one thread. Lowering the thread count will reduce the speed of message throughput.

    When you specify the application to run you are able to pass parameters to it. Along with your own ones you can use the following tokens, which will be substituted with the appropriate value when the filter actions are run.




    Contains the message filename.


    Contains the queue that the message is in. If you need to get access to the email contents you would use this and the [ID] value to determine the location on disk. The location on the disk is:

    [Queue Path]\[CONNECTOR]\Inbound\[ID] for the command file and

    [Queue Path]\[CONNECTOR]\Inbound\Messages\[ID] for the message file


    The queue path is retrieved from the Windows registry value below:

    [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mail Enable\Mail Enable\Connectors]
    "Connector Root Directory"="C:\\Program Files (x86)\\Mail Enable\\QUEUES"


    The current time in the same format as email headers include.

    Add Message Header

    Adds a header line to the email. If the header line already exists it will be replaced.

    Mark as spam

    This will mark the message as spam, which will send the message to a users Junk E-mail folder if the post office option for this is set.  See the Feature selection section for more information on this setting.

    Add Subject Prefix

    This action will add a prefix to the subject of the message. If the prefix already exists for the subject it will not be added.

    Stop processing filters

    This action stops the processing of any more filter actions.