Come and Check our BETA Alpha version of Powershellcenter.net
Send me your comment to Powershell@powershellcenter.com

Synopsis

Configures a filter list for use with the transport scan.

Syntax

Set-FseTransportFilter [-AllowedSender] -List <string> [-Enabled <Boolean>] [-SkipFiltering <SkipFilteringEnum[]>] [<CommonParameters>]

Set-FseTransportFilter [-File] [[-Keyword]] -List <string> [-Action <TransportActionEnum>] [-Enabled <Boolean>] [-IdentifyIn <IdentifyEnum[]>] [-Order <int>] [-Quarantine <boolean>] [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FseTransportFilter [-Keyword] -List <string> [-Action <TransportActionEnum>] [-Enabled <Boolean>] [-IdentifyIn <IdentifyEnum[]>] [-InboundDirection <Boolean>] [-InternalDirection <Boolean>] [-MinimumUniqueHits <int>] [-OutboundDirection <Boolean>] [-Quarantine <boolean>] [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FseTransportFilter [-SenderDomain] [[-Keyword]] -List <string> [-Action <TransportActionEnum>] [-Enabled <Boolean>] [-IdentifyIn <IdentifyEnum[]>] [-Quarantine <boolean>] [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Set-FseTransportFilter [-Subject] -List <string> [-Action <TransportActionEnum>] [-Enabled <Boolean>] [-IdentifyIn <IdentifyEnum[]>] [-Quarantine <boolean>] [-SuppressFilterNotifications <Boolean>] [<CommonParameters>]

Detailed Description

Configures a filter list for use with the transport scan. All new filter lists are automatically associated with the transport scan when they are created with New-FseFilterList. There are five types of filter lists: allowed sender lists, file filter lists, keyword filter lists, subject line filter lists, and sender-domain filter lists. Each is configured with a separate parameter set (-AllowedSender, -File, -Keyword, -Subject, and -SenderDomain) that should be indicated before any of its parameters. Filter names are unique within each filter type. By default, new filters have the following properties for the transport scan: File filters: -Enabled $false -Action Delete -Quarantine $true -IdentifyIn Subject Keyword filters: -Enabled $false -Action Identify -Quarantine $true -IdentifyIn Subject -MinimumUniqueHits 1 -InboundDirection $true -OutboundDirection $true -InternalDirection $true Sender-domain and subject filters: -Enabled $false -Action Identify -Quarantine $true -IdentifyIn Subject Allowed senders: -Enabled $false -Action <none - action does not apply to allowed sender lists> -Quarantine $true -SkipFiltering File,Subject,SenderDomain,Keyword

Parameters

-Action [<TransportActionEnum>]

Specifies the action to be taken if an item matches the filter list criteria. Optional. The possible values are SkipDetect, Purge, Delete, and Identify.

NOTE: The -Action parameter is not used with -AllowedSender lists.

"SkipDetect" (all filter lists) means that if there is a match, a record is kept, but the message is allowed to route normally.

"Purge" (all filter lists) causes the message to be deleted from your mail system; if quarantining is not enabled, the message would then be unrecoverable.

"Delete" (not used with keyword filter lists) removes the file attachment from the message and inserts the deletion text in its place.

"Identify" (all filter lists) means that the subject line or message header of the detected message (as specified by the -IdentifyIn parameter) can be tagged with a customizable word or phrase (the tag text). Messages containing tag text can be identified later for special processing, for routing into specific mailboxes, or for other purposes specified in the Microsoft Forefront Protection 2010 for Exchange Server Administrator Console. There are three Identify actions that can be set with the -IdentifyIn parameter:

Identify in subject (Subject)

Identify in message header (MessageHeader)

Identify in subject and message header (Subject,MessageHeader)

A default value is assigned when the filter list is created. For file filter lists, the default is "Delete", for subject line, sender-domain, and keyword lists, the default is "Identify" (and the IdentifyIn default is "Subject"). If no value is provided with Set-FseTransportFilter, the default setting is maintained.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-AllowedSender [<SwitchParameter>]

A parameter set indicating that this is an allowed sender filter list being configured. Required; you must select one of the parameter sets: -AllowedSender, -File, -Keyword, -SenderDomain, or -Subject.

Required?   true
Position?   1
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-Enabled [<Boolean>]

Enables or disables the filter list. Optional. The possible values are $false and $true. If no value is provided, the current setting is maintained. A value of $false is assigned by default when the filter list is created.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-File [<SwitchParameter>]

A parameter set indicating that this is a file filter list being configured. Required; you must select one of the parameter sets: -AllowedSender, -File, -Keyword, -SenderDomain, or -Subject.

Required?   true
Position?   1
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-IdentifyIn [<IdentifyEnum[]>]

Specifies the location to tag if an action of "Identify" was selected. Optional. The possible values are Subject (place the tag text in the subject line of the message) and MessageHeader (place the tag text in the header of the message). To have the tag text placed in both locations, enter both values as an array: "Subject", "MessageHeader". The default is "Subject".

Tag text is set with the -TagTextSubject and -TagTextHeader parameters of the Set-FseTransportScan cmdlet.

NOTE: The -IdentifyIn parameter is not used with -AllowedSender lists.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-InboundDirection [<Boolean>]

Specifies that messages sent from outside the organization are to be scanned by this filter list. The possible values are $false and $true. The default of $true indicates that inbound messages are scanned. This parameter is only used with the -Keyword parameter set.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-InternalDirection [<Boolean>]

Specifies that messages sent within the organization are to be scanned by this filter list. The possible values are $false and $true. The default of $true indicates that internal messages are scanned. This parameter is only used with the -Keyword parameter set.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-Keyword [<SwitchParameter>]

A parameter set indicating that this is a keyword filter list being configured. Required; you must select one of the parameter sets: -AllowedSender, -File, -Keyword, -SenderDomain, or -Subject.

Required?   true
Position?   1
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-List [<string>]

The name of a single pre-existing filter list to be configured. Required. The name of the filter is case-sensitive. If the string has spaces or non-alphanumeric characters, surround it with quotation marks. Filter names are unique within type.

Filter lists are created with New-FseFilterList.

Required?   true
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-MinimumUniqueHits [<int>]

Specifies how many unique keywords must be matched for the action to be taken. Optional. The default is one (1). For example, you set the minimum unique keyword hits to 3. The word "wonderful", which is in the list of keywords to be filtered, appears three times in the document. However, no other word in the list appears at all. The criteria have not been met, because only one term in the list was matched. This parameter is only used with the -Keyword parameter set.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-Order [<int>]

Specifies the order in which file filter lists are applied during a transport scan. Optional. The value is a whole number; the range begins with 1 (there is no maximum value). When a file filter list is created with New-FseFilterList, the next available number is automatically assigned. If you need to change the order of file filters, you can use the -Order parameter.

Required?   false
Position?   named
Default value?   (1 greater than highest existing position)
Accept pipeline input?   false
Accept wildcard characters?   false

-OutboundDirection [<Boolean>]

Specifies that messages sent out of the organization are to be scanned by this filter list. The possible values are $false and $true. The default of $true indicates that outbound messages are scanned. This parameter is only used with the -Keyword parameter set.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-Quarantine [<boolean>]

Indicates whether a file should be quarantined if the filter list is matched. Optional. The possible values are $false and $true. A value of $true, indicating that a file should be quarantined if the filter list is matched, is assigned by default when the filter list is created. If no value is provided, the current setting is maintained.

NOTE: The -Quarantine parameter is not used with -AllowedSender lists.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-SenderDomain [<SwitchParameter>]

A parameter set indicating that this is a sender-domain filter list being configured. Required; you must select one of the parameter sets: -AllowedSender, -File, -Keyword, -SenderDomain, or -Subject.

Required?   true
Position?   1
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-SkipFiltering [<SkipFilteringEnum[]>]

Indicates the types of filtering to be skipped. Optional. The possible values are File, Keyword, and Content (which includes subject and sender-domain filtering). Multiple types are entered as an array. (For example: File, Keyword.) Use of this parameter enables you to ignore certain types of filtering, but it has no effect on malware scanning.

NOTE: The -SkipFiltering parameter is only used with the -AllowedSender parameter set, which means that certain types of filtering can be skipped for a given list of senders.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-Subject [<SwitchParameter>]

A parameter set indicating that this is a subject filter list being configured. Required; you must select one of the parameter sets: -AllowedSender, -File, -Keyword, -SenderDomain, or -Subject.

Required?   true
Position?   1
Default value?  
Accept pipeline input?   true (ByPropertyName)
Accept wildcard characters?   false

-SuppressFilterNotifications [<Boolean>]

Indicates whether notifications should be sent when this filter is matched by this scan job. Optional. The possible values are $false and $true. The default of $false indicates that if filter notifications are enabled, they are sent. If they were disabled with Set-FseNotification, this parameter has no effect.

Required?   false
Position?   named
Default value?   $false
Accept pipeline input?   false
Accept wildcard characters?   false

Input Type

Return Type

Notes

Examples

EXAMPLE 1

PS> Set-FseTransportFilter -File -List "List1" -Enable $true There is no output if the command completes successfully.

Description

-----------

Enables a file filter list called "List1". The default "Delete" action and quarantining of detected files are maintained.

EXAMPLE 2

PS> Set-FseTransportFilter -File -List "List1" -Enabled $false There is no output if the command completes successfully.

Description

-----------

Disables a file filter list called "List1". This assumes that the filter list had once been enabled, as new filter lists are disabled by default.

EXAMPLE 3

PS> Set-FseTransportFilter -Keyword -List "Banned Words" -Enabled $true -Action Purge -MinimumUniqueHits 3 -InternalDirection $false There is no output if the command completes successfully.

Description

-----------

Enables the "Banned Words" keyword filter list for the transport scan. If at least three of the words or phrases in the list are matched, the message is purged. Internal mail is not filtered. The filter uses the default settings for -Quarantine, -InboundDirection, and -OutboundDirection.

EXAMPLE 4

PS> Set-FseTransportFilter -Keyword -list "Questionable Words" -Action Identify -IdentifyIn Subject, MessageHeader -OutboundDirection $false -Enabled $true There is no output if the command completes successfully.

Description

-----------

Enables the "Questionable Words" keyword filter list to scan messages. If any of the items in the list are matched, the filter places the tag text in both the subject line and the message header. Messages leaving the organization are not scanned, but those entering the organization and those that are sent within the organization are (the defaults, which were not changed).

EXAMPLE 5

PS> Set-FseTransportFilter -AllowedSender -List "ApprovedSenders" -Enabled $true -SkipFiltering File, Keyword, Subject, SenderDomain There is no output if the command completes successfully.

Description

-----------

Enables the "ApprovedSenders" filter list. All types of filtering are skipped for any message from a sender on the list.