Recipient List Filter

Recipient List Filter
Prev	filters	Next

Name

filter

Recipient List Filter — Applies an action to an email based on if a recipient is found in a list or not

<filter class="xms.filter.recipient.RecipientListFilter" … />

Table 21. Attributes for filter tag (for xms.filter.recipient.RecipientListFilter)

Name	Description	Type	Default Value	Required
action	The action to take when a recipient is matched	ActionEnum One of the following values: accept,drop,reject,tempfail,error	drop	no
domains	Domains to use or * for any	String any character combination	*	no
fullAddress	If set, include the full email address when querying the user list.	boolean true or false	none	no
mode	Set to inclusive to match if the person is on the list, exclusive to match anyone not on the list	Mode One of the following values: inclusive,exclusive	none	yes
userList	The name of the list to use	StringList Name of a StringList as defined in StringListService	none	yes

Service Dependencies

This tag depends on the following services (or a service that extends or implements these classes)

xms.dataservices.StringListService
- XMS String List Service

Example 26. Example configuration for Recipient List Filter

Required attributes are marked with a bold typeface

<filter class="xms.filter.recipient.RecipientListFilter"
      action="action"
      domains="domains"
      fullAddress="fullAddress"
      mode="mode"
      userList="userList" />

Prev	Up	Next
Multiplexer Map Filter	Home	Reg Ex Filter