Skip to content

Commit 565e2d1

Browse files
chrisdachrisda
committed
Initial upload
Initial upload of Exchange cmdlet ref topics.
1 parent d62771c commit 565e2d1

File tree

1,177 files changed

+472326
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,177 files changed

+472326
-1
lines changed

‎exchange/exchange-ps/exchange/Add-ADPermission.md

Lines changed: 452 additions & 0 deletions
Large diffs are not rendered by default.

‎exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md

Lines changed: 221 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
---
2+
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
3+
schema: 2.0.0
4+
---
5+
6+
# add-attachmentfilterentry
7+
8+
## SYNOPSIS
9+
!!! Exchange Server 2010
10+
11+
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.
12+
13+
!!! Exchange Server 2013
14+
15+
This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange Server 2013.
16+
17+
Use the Add-AttachmentFilterEntry cmdlet to add an entry to the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers.
18+
19+
!!! Exchange Server 2016
20+
21+
This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange.
22+
23+
Use the Add-AttachmentFilterEntry cmdlet to add an entry to the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers.
24+
25+
## SYNTAX
26+
27+
```
28+
add-attachmentfilterentry [-Name] <String> -Type <ContentType | FileName> [-Confirm] [-DomainController <Fqdn>]
29+
[-WhatIf] [<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
!!! Exchange Server 2010
34+
35+
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.
36+
37+
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.
38+
39+
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.
40+
41+
!!! Exchange Server 2013
42+
43+
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.
44+
45+
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 - Edge Transport" entry in the Anti-spam and anti-malware permissions topic.
46+
47+
!!! Exchange Server 2016
48+
49+
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.
50+
51+
On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet.
52+
53+
## EXAMPLES
54+
55+
### Example 1 -------------------------- (Exchange Server 2010)
56+
```
57+
Add-AttachmentFilterEntry -Name *.txt -Type FileName
58+
```
59+
60+
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.
61+
62+
### Example 1 -------------------------- (Exchange Server 2013)
63+
```
64+
Add-AttachmentFilterEntry -Name *.txt -Type FileName
65+
```
66+
67+
This example adds an attachment filter entry based on a file name. After running this command, the Attachment Filtering agent filters all attachments that have a .txt extension.
68+
69+
### Example 1 -------------------------- (Exchange Server 2016)
70+
```
71+
Add-AttachmentFilterEntry -Name *.txt -Type FileName
72+
```
73+
74+
This example adds an attachment filter entry based on a file name. After running this command, the Attachment Filtering agent filters all attachments that have a .txt extension.
75+
76+
### Example 2 -------------------------- (Exchange Server 2010)
77+
```
78+
Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType
79+
```
80+
81+
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.
82+
83+
### Example 2 -------------------------- (Exchange Server 2013)
84+
```
85+
Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType
86+
```
87+
88+
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 Filtering agent filters all attachments of the MIME content type image/jpeg.
89+
90+
### Example 2 -------------------------- (Exchange Server 2016)
91+
```
92+
Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType
93+
```
94+
95+
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 Filtering agent filters all attachments of the MIME content type image/jpeg.
96+
97+
## PARAMETERS
98+
99+
### -Name
100+
The Name parameter specifies the MIME content type or file name of the attachment. If the Type parameter is set to FileName, the Name parameter can take any exact file name, such as BadFile.exe, or file name extension, such as \*.exe. If the Type parameter is set to ContentType, the Name parameter can take any valid MIME content type.
101+
102+
```yaml
103+
Type: String
104+
Parameter Sets: (All)
105+
Aliases:
106+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
107+
108+
Required: True
109+
Position: 1
110+
Default value: None
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
115+
### -Type
116+
!!! Exchange Server 2010, Exchange Server 2013
117+
118+
The Type parameter specifies what type of attachment the attachment filter entry blocks. Valid values are ContentType and FileName:
119+
120+
- ContentType This value matches the attachment filter entry against the MIME content type specified in the Name parameter.
121+
122+
- FileName This value matches the attachment filter entry against the simple file name specified in the Name parameter.
123+
124+
125+
126+
!!! Exchange Server 2016
127+
128+
The Type parameter specifies what type of attachment the attachment filter entry blocks. Valid values are ContentType and FileName:
129+
130+
- ContentType: This value matches the attachment filter entry against the MIME content type specified in the Name parameter.
131+
132+
- FileName: This value matches the attachment filter entry against the simple file name specified in the Name parameter.
133+
134+
135+
136+
```yaml
137+
Type: ContentType | FileName
138+
Parameter Sets: (All)
139+
Aliases:
140+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
141+
142+
Required: True
143+
Position: Named
144+
Default value: None
145+
Accept pipeline input: False
146+
Accept wildcard characters: False
147+
```
148+
149+
### -Confirm
150+
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.
151+
152+
- 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.
153+
154+
- 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.
155+
156+
```yaml
157+
Type: SwitchParameter
158+
Parameter Sets: (All)
159+
Aliases:
160+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
161+
162+
Required: False
163+
Position: Named
164+
Default value: None
165+
Accept pipeline input: False
166+
Accept wildcard characters: False
167+
```
168+
169+
### -DomainController
170+
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.
171+
172+
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.
173+
174+
```yaml
175+
Type: Fqdn
176+
Parameter Sets: (All)
177+
Aliases:
178+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
179+
180+
Required: False
181+
Position: Named
182+
Default value: None
183+
Accept pipeline input: False
184+
Accept wildcard characters: False
185+
```
186+
187+
### -WhatIf
188+
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.
189+
190+
```yaml
191+
Type: SwitchParameter
192+
Parameter Sets: (All)
193+
Aliases:
194+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
195+
196+
Required: False
197+
Position: Named
198+
Default value: None
199+
Accept pipeline input: False
200+
Accept wildcard characters: False
201+
```
202+
203+
### CommonParameters
204+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
205+
206+
## INPUTS
207+
208+
###
209+
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.
210+
211+
## OUTPUTS
212+
213+
###
214+
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.
215+
216+
## NOTES
217+
218+
## RELATED LINKS
219+
220+
[Online Version](https://technet.microsoft.com/library/9c9d35c8-2833-443f-ab50-c7232be4aba4.aspx)
221+

0 commit comments

Comments
 (0)