Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Create an email filter

Log in to subscribe to topics and get notified when content changes.

Create an email filter

You can create email filters to apply a custom action script or filter actions when email matches your filter's conditions.

Before you begin

Role required: admin


  1. Navigate to System Mailboxes > Administration > Filters.
  2. Click New.
  3. Complete the fields (see the table).
  4. Right-click in the header bar and select Save from the context menu.

    The Filter Actions related list appears.

  5. Click New in the related list.
  6. Select how the system should react when the conditions of this filter evaluate to true.

    The two choices in the base system are: Mark as Ignored and Move to Junk. You can use the Action script to perform additional email tasks.

    Table 1. New filter table
    Field Description
    Name Brief, descriptive name for this filter.
    Order Define an order for this filter to determine when it is evaluated. By default, the Ignore VCAL filter has the lowest order number and is evaluated first.
    Active Select the check box (true) to enable this filter.
    Short description Concise description of the function of this filter.
    Conditions Add conditions for this filter with the condition builder or with a condition script. Note that conditions are case sensitive.
    Condition script Create a script that defines the conditions for this filter. Use this script to access other tables, variables, or methods. For example, the condition script for the Ignore VCAL filter looks for the results of the EmailUtils script include, which detects vCalendar attachments.
    Action script Use the action script to define additional behavior to be performed when the filter condition evaluates to true. This might include an email action not included in the default filter actions. In the base system, the action script is used to produce the error string that is published to the email log (System Logs > Email).
    Note: Before creating additional email actions with a script, see Inbound Email Actions. Like business rules, inbound email actions use both conditions and scripts and can provide a number of useful actions on emails the instance receives.