Remove-AttachmentFilterEntry

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. Use the Remove-AttachmentFilterEntry cmdlet to remove an entry from the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Remove-AttachmentFilterEntry
      [-Identity] <String>
      [-Confirm]
      [-DomainController <Fqdn>]
      [-WhatIf]
      [<CommonParameters>]

Description

On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see Set-AttachmentFilterListConfig.

On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet.

Examples

-------------------------- Example 1 --------------------------

Remove-AttachmentFilterEntry -Identity FileName:*.txt

This example removes the attachment filter entry that filters file names with a .txt extension.

-------------------------- Example 2 --------------------------

Remove-AttachmentFilterEntry -Identity ContentType:image/jpeg

This example removes the attachment filter entry that filters attachments that have the MIME content type image/jpeg.

Required Parameters

-Identity

The Identity parameter specifies the type of attachment that this filter entry removes. The Identity parameter accepts values in the format Type:Name, where Type is one of the following two values:

  • ContentType: This value matches the attachment filter entry against the MIME content type.

  • FileName: This value matches the attachment filter entry against the simple file name.

In Type:Name, Name can be either the file name of the attachment filter entry to be removed, or the content type of the attachment filter entry to be removed.

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

Optional Parameters

-Confirm

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-DomainController

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-WhatIf

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.