Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2011-05-03
Use the Add-AttachmentFilterEntry cmdlet to add an entry to the attachment filter list on a computer that has the Edge Transport server role installed.
Syntax
add-attachmentfilterentry -Name <String> -Type
<ContentType | FileName> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The Attachment Filter agent can block attachments from entering your Microsoft Exchange Server 2010 organization based on the content type and the file name of the attachment. You can use the Add-AttachmentFilterEntry cmdlet to add file names or MIME content types to the list of attachments that are filtered.
The configuration of the Attachment Filter agent determines how attachments are processed. For more information about how to configure the Attachment Filter agent, see Set-AttachmentFilterListConfig.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Anti-spam features" entry in the Transport Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Name |
Required |
System.String |
The Name parameter specifies the MIME content type or
file name of the attachment. If the Type parameter is set to
|
Type |
Required |
Microsoft.Exchange.Data.Directory.SystemConfiguration.AttachmentType |
The Type parameter specifies what type of attachment the
attachment filter entry blocks. Valid values are
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role writes only to the Active Directory Lightweight Directory Services (AD LDS) instance. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.
Examples
EXAMPLE 1
This example adds an attachment filter entry based on a file name. After running this command, the Attachment Filter agent filters all attachments that have a .txt extension.
Copy Code | |
---|---|
Add-AttachmentFilterEntry -Name *.txt -Type FileName |
EXAMPLE 2
This example adds an attachment filter entry based on
the MIME content type image/jpeg
, which is a JPEG
image binary file. After running this command, the Attachment
Filter agent filters all attachments of the MIME content type
image/jpeg
.
Copy Code | |
---|---|
Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType |