New-MailboxSearch

参考

模块:: ExchangePowerShell

适用于:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。一些参数和设置可能只适用于某个特定的环境。

使用 New-MailboxSearch cmdlet 创建邮箱搜索，并得到搜索结果的估计值，将搜索结果置于就地保留或将其复制到发现邮箱。也可以不指定搜索查询，将类似结果作为诉讼保留完成，从而保留邮箱中的所有内容。

注意：自 2020 年 10 月起，*-MailboxSearch cmdlet 在 PowerShell Exchange Online 停用。请改用安全性 & 合规性 PowerShell 中的 *-ComplianceSearch cmdlet。有关详细信息，请参阅旧版电子数据展示工具的停用。

有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。

语法

New-MailboxSearch
   [-Name] <String>
   [-AllPublicFolderSources <Boolean>]
   [-AllSourceMailboxes <Boolean>]
   [-Confirm]
   [-Description <String>]
   [-DomainController <Fqdn>]
   [-DoNotIncludeArchive]
   [-EndDate <ExDateTime>]
   [-EstimateOnly]
   [-ExcludeDuplicateMessages <Boolean>]
   [-Force]
   [-IncludeKeywordStatistics]
   [-IncludeUnsearchableItems]
   [-InPlaceHoldEnabled <Boolean>]
   [-InPlaceHoldIdentity <String>]
   [-ItemHoldPeriod <Unlimited>]
   [-Language <CultureInfo>]
   [-LogLevel <LoggingLevel>]
   [-MessageTypes <KindKeyword[]>]
   [-Recipients <String[]>]
   [-SearchDumpster]
   [-SearchQuery <String>]
   [-Senders <String[]>]
   [-SourceMailboxes <RecipientIdParameter[]>]
   [-StartDate <ExDateTime>]
   [-StatusMailRecipients <RecipientIdParameter[]>]
   [-TargetMailbox <MailboxIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

说明

New-MailboxSearch cmdlet 可创建就地 eDiscovery 搜索或就地保留。可以停止、启动、修改或删除搜索。

默认情况下，邮箱搜索将跨组织中的所有 Exchange 2013 或更高版本邮箱服务器执行，除非使用 SourceMailboxes 参数将搜索限制为更少的邮箱。若要在 Exchange 2010 邮箱服务器上搜索邮箱，请在 Exchange 2010 服务器上运行命令。

有关详细信息，请参阅 Exchange Server 中的就地电子数据展示和 Exchange Server 中的就地保留和诉讼保留。

您必须先获得权限，然后才能运行此 cmdlet。虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。

示例

示例 1

New-MailboxSearch -Name "Legal-ProjectX" -SourceMailboxes DG-Marketing,DG-Executives -TargetMailbox LegalDiscovery@contoso.com -StartDate "01/01/2018" -EndDate "12/31/2018" -Recipients "@contoso.com" -SearchQuery "project report hasattachments:true" -StatusMailRecipients "DG-DiscoveryTeam"

本示例创建邮箱搜索 Legal-ProjectX。此搜索会使用几个参数来限制搜索查询：

SourceMailboxes：此参数将搜索限制为DG-Marketing和DG-Executives通讯组的成员。
Recipients：此参数指定搜索包括发送到域 contoso.com 的所有邮件。
SearchQuery：此参数为带有项目或报表单词的邮件以及带有附件的邮件指定 KQL 查询。
StartDate 和 EndDate：这些参数指定搜索的开始日期为 2018 年 1 月 1 日，结束日期为 2018 年 12 月 31 日。
TargetMailbox：此参数指定搜索结果应复制到发现邮箱 LegalDiscovery。
StatusMailRecipients：此参数指定通讯组DG-DiscoveryTeam在搜索完成后接收通知。

示例 2

New-MailboxSearch -Name "Hold-ProjectX" -SourceMailboxes DG-Finance -InPlaceHoldEnabled $true

此示例创建名为 Hold-ProjectX 的In-Place保留，并将通讯组的所有成员DG-Finance置于保留状态。因为该搜索不指定 SearchQuery 和 ItemHoldPeriod 参数，因此将对返回的邮箱中的所有邮件执行无限就地保留。

示例 3

New-MailboxSearch -Name "Hold-tailspintoys" -SourceMailboxes DG-Research -SearchQuery '"Patent" AND "Project tailspintoys"' -InPlaceHoldEnabled $true

此示例创建名为 Hold-tailspintoys 的In-Place保留，并将通讯组的所有成员DG-Research置于保留状态。因为该搜索指定了 SearchQuery 参数，因此仅对匹配搜索查询的邮件执行无限就地保留。

示例 4

New-MailboxSearch -Name "Hold for all PFs" -AllPublicFolderSources $true -InPlaceHoldEnabled $true

在本地 Exchange 中，本示例为将所有公用文件夹中的内容置于In-Place保留状态的所有 PF 创建名为“保留”的In-Place保留，并无限期保留。

参数

-AllPublicFolderSources

AllPublicFolderSources 参数指定搜索中是否包含组织中的所有公用文件夹。有效值包含:

$true：搜索中包含所有公用文件夹。当 AllSourceMailboxes 参数的值$false并且未使用 SourceMailboxes 参数指定一个或多个源邮箱时， (参数值为空白 [$null]) ，则此值是必需的。
$false：搜索中不包含公用文件夹。此值为默认值。当 AllSourceMailboxes 参数的值$true或者使用 SourceMailboxes 参数指定一个或多个源邮箱时，可以使用此值 (参数值不为空 [$null]) 。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online

-AllSourceMailboxes

AllSourceMailboxes 参数指定是否要在搜索中包含所有邮箱。有效值包含:

$true：搜索中包含所有邮箱。如果 AllPublicFolderSources 参数的值$false并且未使用 SourceMailboxes 参数指定一个或多个源邮箱， (参数值为空白 [$null]) ，则此值是必需的。
$false：搜索中不包括所有邮箱。此值为默认值。当 AllPublicFolderSources 参数的值$true或者使用 SourceMailboxes 参数指定一个或多个源邮箱时，可以使用此值 (参数值不为空 [$null]) 。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, Exchange Online

-Confirm

Confirm 开关指定是否显示确认提示。此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

破坏性 cmdlet (例如，Remove-* cmdlet) 具有内置的暂停，该暂停会强制你在继续操作之前确认命令。对于这些 cmdlet，您可以使用此确切语法跳过确认提示：-Confirm:$false。
大多数其他 cmdlet (例如，New-* 和 Set-* cmdlet) 没有内置暂停。对于这些 cmdlet，指定不含值的 Confirm 开关会引入暂停，从而强制要求你先确认命令，然后再继续操作。

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

-Description

Description 参数指定搜索说明。该说明不对用户显示。如果值中有空格，请使用双引号 (") 将此值括起来。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-DomainController

此参数只在本地 Exchange 中可用。

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。可以使用完全限定的域名 (FQDN) 来标识域控制器。例如，dc01.contoso.com。

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

-DoNotIncludeArchive

此参数仅在 2010 Exchange Server可用。

DoNotIncludeArchive 开关指定搜索中不包括存档邮箱。不必为此开关指定值。

默认情况下，存档邮箱包含在搜索中。若要排除存档邮箱，请使用此开关。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010

-EndDate

EndDate 参数指定日期范围的结束日期。

请使用短日期格式，该格式在运行命令的计算机上的“区域选项”设置中定义。例如，如果将计算机配置为使用短日期格式 mm/dd/yyyy，请输入 09/01/2018 来指定 2018 年 9 月 1 日。可以只输入日期，也可以输入当天的日期和时间。如果输入当天的日期和时间，请将该值括在引号 (") 中，例如，"09/01/2018 5:00 PM"。

Type:	ExDateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-EstimateOnly

EstimateOnly 开关指定仅提供将返回的项目的估计数量。不必为此开关指定值。

如果不使用此开关，邮件将被复制到目标邮箱。

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

-ExcludeDuplicateMessages

ExcludeDuplicateMessages 参数排除搜索结果中重复的邮件。有效值包含:

$true：如果同一邮件存在于多个文件夹或邮箱中，则复制邮件的单个实例。此值为默认值。
$false：如果同一邮件存在于多个文件夹或邮箱中，请复制邮件的所有实例。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Force

强制开关隐藏警告或确认消息。不必为此开关指定值。

您可以在以编程方式运行任务时使用此开关，因为此时并不适合提示用户提供管理输入。

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

-IncludeKeywordStatistics

IncludeKeywordStatistics 开关返回搜索结果中的关键字统计信息（每个关键字的实例数）。不必为此开关指定值。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-IncludeUnsearchableItems

IncludeUnsearchableItems 开关指定在结果中应包含 Exchange 搜索无法编制索引的项目。不必为此开关指定值。

对于基于查询的就地保留，不会保留不可搜索项目。如果需要将不可搜索项目置于保留状态，必须创建一个无限期保留（不指定任何参数的保留，提供的功能类似于诉讼保留）。

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

-InPlaceHoldEnabled

InPlaceHoldEnabled 参数指定是否在搜索结果中对项目设置就地保留。有效值包含:

$true：对搜索结果启用In-Place保留。
$false：对搜索结果未启用In-Place保留。此值为默认值。

当 AllSourceMailboxes 参数为 $true，无法对搜索结果设置就地保留。

如果尝试保留但未使用 SourceMailboxes 参数指定邮箱，则命令可能会成功，但邮箱不会置于保留In-Place。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-InPlaceHoldIdentity

保留此参数以供 Microsoft 内部使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-ItemHoldPeriod

ItemHoldPeriod 参数对邮箱项目（所有邮箱项目或搜索查询结果中返回的项目）指定就地保留的天数。持续时间从邮箱中接收到或创建项目的时间计算而来。有效值为：

SyncSchedule 参数指定 ???。此参数的有效值是：
值 unlimited。此值为默认值。项目一直保留到删除In-Place保留，方法是使用 Remove-MailboxSearch cmdlet 删除搜索，使用 Set-MailboxSearch cmdlet 和 SourceMailboxes 参数从搜索中删除源邮箱;在本地 Exchange 中，通过使用 Set-MailboxSearch cmdlet 将 AllPublicFolderSources 参数从 $true 更改为 $false，从搜索中删除所有公用文件夹。

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-Language

Language 参数为搜索指定区域设置。

此参数的有效输入是 Microsoft .NET Framework CultureInfo 类支持的区域性代码值。例如，da-DK 表示丹麦语，ja-JP 表示日语。有关详细信息，请参阅 CultureInfo 类。

Type:	CultureInfo
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-LogLevel

LogLevel 参数指定搜索的日志记录级别。有效值包含:

禁止显示：不保留任何日志。
基本信息：保留有关查询及其运行者的基本信息。此值为默认值。
完整：除了基本日志级别保留的信息外，完整日志级别还会添加搜索结果的完整列表。

Type:	LoggingLevel
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-MessageTypes

MessageTypes 参数指定要包括在搜索查询中的邮件类型。有效值包含:

联系人
Docs
电子邮件
IM
期刊
会议
注意
任务

可以指定用逗号分隔的多个值。

默认值为空 ($null)，这意味着所有邮件类型都包括在内。

Type:	KindKeyword[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Name

Name 参数为搜索指定一个友好名称。如果值中有空格，请使用双引号 (") 将此值括起来。

此参数的值用于创建在由 TargetMailbox 参数指定的目标邮箱中保留搜索结果的顶级文件夹。

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

-Recipients

Recipients 参数指定一个或多个收件人包含在搜索查询中。搜索结果中将返回“收件人”、“抄送”、“密件抄送”字段中有指定收件人的邮件。

可以指定多个收件人，中间用逗号分隔。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-SearchDumpster

此参数仅在 2010 Exchange Server可用。

SearchDumpster 开关指定是否搜索转储程序。不必为此开关指定值。

转储是邮箱中的一个存储区域，在删除或从“已删除邮件”文件夹中删除或删除邮件后，或者根据“已删除邮件保留期”设置从邮箱中清除之前，将暂时存储已删除邮件。

Type:	SwitchParameter
Position:	Named
Default value:	True
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010

-SearchQuery

SearchQuery 参数通过使用关键字查询语言 (KQL) 指定搜索查询的关键字。有关详细信息，请参阅关键字查询语言 (KQL) 语法参考和电子数据展示的关键字查询和搜索条件。

如果将此参数与其他搜索查询参数一起使用，则查询将通过使用 AND 运算符组合这些参数。

其他搜索查询参数为：

EndDate
MessageTypes
收件人
发件人
StartDate

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Senders

Senders 参数指定一个或多个发件人以包含在搜索查询中。搜索结果中将返回具有指定发件人的邮件。发件人可以包括用户、通讯组（组成员发送的邮件）、SMTP 地址或域。

可以指定用逗号分隔的多个发件人。如果值中有空格，请使用双引号 (") 将此值括起来。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-SourceMailboxes

SourceMailboxes 参数指定要搜索的一个或多个邮箱的标识。可以使用能够唯一标识邮箱的任意值。例如：

名称
别名
可分辨名称 (DN)
可分辨名称 (DN)
规范 DN
GUID

Update 如果值包含空格或需要引号，请使用以下语法： "Value1","Value2",..."ValueN"。

若要使用此参数，需要将 AllSourceMailboxes 参数$false (默认值) 。

默认值为空 ($null)，这意味着未指定源邮箱。若要清除源邮箱，请使用值 $null。

若要在搜索结果上启用In-Place保留，需要将 AllSourceMailboxes 参数设置为$false (默认值) 并配置以下一个或两个设置：

通过使用 SourceMailboxes 参数指定一个或多个源邮箱。
在本地 Exchange 中，将 AllPublicFolderSources 参数设置为 $true。

Type:	RecipientIdParameter[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-StartDate

StartDate 参数指定日期范围的起始日期。

Type:	ExDateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-StatusMailRecipients

StatusMailRecipients 参数指定一个或多个收件人，以在完成搜索时接收状态电子邮件。可以使用任何能够唯一标识该收件人的值。例如：

名称
别名
可分辨名称 (DN)
可分辨名称 (DN)
规范 DN
GUID