You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
4
+
applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
5
5
title: Search-Mailbox
6
6
schema: 2.0.0
7
7
author: chrisda
@@ -12,11 +12,11 @@ ms.reviewer:
12
12
# Search-Mailbox
13
13
14
14
## SYNOPSIS
15
-
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
15
+
This cmdlet is available only in on-premises Exchange.
16
16
17
17
Use the Search-Mailbox cmdlet to search a mailbox and copy the results to a specified target mailbox, delete messages from the source mailbox, or both.
18
18
19
-
**Note**: In cloud-based environments, the Search-Mailbox cmdlet is being deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets.
19
+
**Note**: In cloud-based environments, the Search-Mailbox cmdlet was deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets.
20
20
21
21
By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to *any* role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group).
22
22
@@ -132,7 +132,7 @@ The Identity parameter specifies the identity of the mailbox to search. You can
132
132
Type: MailboxOrMailUserIdParameter
133
133
Parameter Sets: (All)
134
134
Aliases:
135
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
135
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
136
136
137
137
Required: True
138
138
Position: 1
@@ -150,7 +150,7 @@ You can't use this switch with the TargetMailbox parameter.
150
150
Type: SwitchParameter
151
151
Parameter Sets: EstimateResult
152
152
Aliases:
153
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
153
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
154
154
155
155
Required: True
156
156
Position: Named
@@ -166,7 +166,7 @@ The TargetFolder parameter specifies a folder name in which search results are s
166
166
Type: String
167
167
Parameter Sets: Mailbox
168
168
Aliases:
169
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
169
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
170
170
171
171
Required: True
172
172
Position: Named
@@ -195,7 +195,7 @@ You must use this parameter with the TargetFolder parameter. You can't use this
195
195
Type: MailboxIdParameter
196
196
Parameter Sets: Mailbox
197
197
Aliases:
198
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
198
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
199
199
200
200
Required: True
201
201
Position: Named
@@ -214,7 +214,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho
214
214
Type: SwitchParameter
215
215
Parameter Sets: (All)
216
216
Aliases: cf
217
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
217
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
218
218
219
219
Required: False
220
220
Position: Named
@@ -236,7 +236,7 @@ Before you use the DeleteContent switch to delete content, we recommend that you
236
236
Type: SwitchParameter
237
237
Parameter Sets: Mailbox, Identity
238
238
Aliases:
239
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
239
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in on-premises Exchange.
250
-
251
249
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.
252
250
253
251
```yaml
@@ -274,7 +272,7 @@ If auto-expanding archiving is enabled for an Exchange Online mailbox, only the
274
272
Type: SwitchParameter
275
273
Parameter Sets: (All)
276
274
Aliases:
277
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
275
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
278
276
279
277
Required: False
280
278
Position: Named
@@ -292,7 +290,7 @@ Use this switch to hide the confirmation prompt when you use the DeleteContent s
292
290
Type: SwitchParameter
293
291
Parameter Sets: (All)
294
292
Aliases:
295
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
293
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
296
294
297
295
Required: False
298
296
Position: Named
@@ -308,7 +306,7 @@ The IncludeUnsearchableItems switch includes items that couldn't be indexed by E
308
306
Type: SwitchParameter
309
307
Parameter Sets: (All)
310
308
Aliases:
311
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
309
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
312
310
313
311
Required: False
314
312
Position: Named
@@ -332,7 +330,7 @@ When you included this parameter, an email message is created and sent to the ma
332
330
Type: LoggingLevel
333
331
Parameter Sets: Mailbox
334
332
Aliases:
335
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
333
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
336
334
337
335
Required: False
338
336
Position: Named
@@ -350,7 +348,7 @@ The logging level is specified by using the LogLevel parameter.
350
348
Type: SwitchParameter
351
349
Parameter Sets: Mailbox
352
350
Aliases:
353
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
351
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
354
352
355
353
Required: False
356
354
Position: Named
@@ -368,7 +366,7 @@ By default, the Recoverable Items folder is always included in the search. To ex
368
366
Type: SwitchParameter
369
367
Parameter Sets: (All)
370
368
Aliases:
371
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
369
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
372
370
373
371
Required: False
374
372
Position: Named
@@ -388,7 +386,7 @@ You can also use this switch with the DeleteContent switch to delete messages fr
388
386
Type: SwitchParameter
389
387
Parameter Sets: (All)
390
388
Aliases:
391
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
389
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
392
390
393
391
Required: False
394
392
Position: Named
@@ -408,7 +406,7 @@ If this parameter is empty, all messages are returned.
408
406
Type: String
409
407
Parameter Sets: (All)
410
408
Aliases:
411
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
409
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
412
410
413
411
Required: False
414
412
Position: Named
@@ -424,7 +422,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch
424
422
Type: SwitchParameter
425
423
Parameter Sets: (All)
426
424
Aliases: wi
427
-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
425
+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
0 commit comments