Set-MailboxSearch

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-MailboxSearch cmdlet to modify an existing mailbox search.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-MailboxSearch -Identity <EwsStoreObjectIdParameter> [-AllPublicFolderSources <$true | $false>] [-AllSourceMailboxes <$true | $false>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-DomainController <Fqdn>] [-EndDate <ExDateTime>] [-EstimateOnly <$true | $false>] [-ExcludeDuplicateMessages <$true | $false>] [-Force <SwitchParameter>] [-IncludeKeywordStatistics <SwitchParameter>] [-IncludeUnsearchableItems <$true | $false>] [-InPlaceHoldEnabled <$true | $false>] [-ItemHoldPeriod <Unlimited>] [-Language <String>] [-LogLevel <Suppress | Basic | Full>] [-MessageTypes <KindKeyword[]>] [-Name <String>] [-PublicFolderSources <PublicFolderIdParameter[]>] [-Recipients <String[]>] [-SearchQuery <String>] [-Senders <String[]>] [-SourceMailboxes <RecipientIdParameter[]>] [-StartDate <ExDateTime>] [-StatisticsStartIndex <Int32>] [-StatusMailRecipients <RecipientIdParameter[]>] [-TargetMailbox <MailboxIdParameter>] [-WhatIf [<SwitchParameter>]]

This example modifies the start date of a mailbox search.

Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2016"

In on-premises Exchange, this example adds all public folders to the existing mailbox search named Legal-ProjectX

Set-MailboxSearch -Identity "Legal-ProjectX" -AllPublicFolderSources $true

Note:

If we wanted to place the results of this search on In-Place Hold, the AllSourceMailboxes parameter must be set to $false. We could still include specific mailboxes in the search by using the SourceMailboxes parameter.

In on-premises Exchange and Exchange Online, mailbox searches are used for In-Place eDiscovery and In-Place Hold. For In-Place eDiscovery, unless specified, mailboxes on all Mailbox servers in an organization are searched. To create an In-Place Hold, you need to specify the mailboxes to place on hold using the SourceMailboxes parameter. The search can be stopped, started, modified, and removed.

CautionCaution:
By default, mailbox searches are performed across all Exchange 2016 and Exchange 2013 Mailbox servers in an Exchange organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server.
If the In-Place eDiscovery search you want to modify is running, stop it before using the Set-MailboxSearch cmdlet. When restarting a search, any previous search results are removed from the target mailbox.

For more information, see In-Place eDiscovery in Exchange 2016 and In-Place Hold and Litigation Hold in Exchange 2016.

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 "In-Place eDiscovery" and "In-Place Hold" entries in the Messaging policy and compliance permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.EwsStoreObjectIdParameter

The Identity parameter specifies the name of the mailbox search that you want to modify. If the value contains spaces, enclose the value in quotation marks (").

AllPublicFolderSources

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

The AllPublicFolderSources parameter specifies whether to include all public folders in the organization in the search. Valid values are:

  • $true   All public folders are included in the search. This value is required when:

    •  The value of the AllSourceMailboxes parameter is $false.

    And

    •  You don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]).

  • $false   No public folders are included in the search. This is the default value. You can use this value when:

    •  The value of the AllSourceMailboxes parameter is $true.

    Or

    •  You specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]).

AllSourceMailboxes

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

The AllSourceMailboxes parameter specifies whether to include all mailboxes in the search. Valid values are:

  • $true   All mailboxes are included in the search. This value is required when:

    •  The value of the AllPublicFolderSources parameter is $false.

    And

    •  You don't specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value is blank [$null]).

  • $false   All mailboxes aren't included in the search. This is the default value. You can use this value when:

    •  The value of the AllPublicFolderSources parameter is $true.

    Or

    •  You specify one or more source mailboxes by using the SourceMailboxes parameter (the parameter value isn't blank [$null]).

Confirm

Optional

System.Management.Automation.SwitchParameter

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.

Description

Optional

System.String

The Description parameter specifies a description for the search. If the value contains spaces, enclose the value in quotation marks (").

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

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.

EndDate

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The EndDate parameter specifies the end date of the date range.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".

To clear the end date, use the value $null.

EstimateOnly

Optional

System.Boolean

The EstimateOnly parameter specifies whether to provide only an estimate of the number of items that will be returned. Valid values are:

  • $true   Messages aren't copied to the target mailbox, and only an estimate of the number of items is returned.

  • $false   Messages are copied to the target mailbox.

ExcludeDuplicateMessages

Optional

System.Boolean

The ExcludeDuplicateMessages parameter eliminates duplication of messages across mailboxes in an In-Place eDiscovery search. Valid values are:

  • $true   Copy a single instance of a message if the same message exists in multiple folders or mailboxes. This is the default value.

  • $false   Copy all instances of a message if the same message exists in multiple folders or mailboxes.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

Use this to switch suppress the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted.

IncludeKeywordStatistics

Optional

System.Management.Automation.SwitchParameter

The IncludeKeywordStatistics switch returns keyword statistics (number of instances for each keyword). You don't need to specify a value with this switch.

IncludeUnsearchableItems

Optional

System.Boolean

The IncludeUnsearchableItems parameter specifies whether items that couldn't be indexed by Exchange Search should be included in the results. Valid values are:

  • $true   Unsearchable items are included in the results.

  • $false   Unsearchable items aren't included in the results. This is the default value.

CautionCaution:
Unsearchable items aren't placed on hold for a query-based In-Place Hold. If you need to place unsearchable items on hold, you need to create an indefinite hold (a hold without specifying any search parameters, which provides functionality similar to Litigation Hold.

InPlaceHoldEnabled

Optional

System.Boolean

The InPlaceHoldEnabled parameter specifies whether to set an In-Place Hold on items in the search results. Valid values are:

  • $true   In-Place Hold is enabled on the search results.

  • $false   In-Place Hold isn't enabled on the search results. This is the default value.

You can't set an In-Place Hold on the search results when the AllSourceMailboxes parameter is $true.

importantImportant:
If you attempt to place a hold but don’t specify mailboxes using the SourceMailboxes parameter, the command may succeed but the mailboxes are not placed on In-Place Hold.

ItemHoldPeriod

Optional

Microsoft.Exchange.Data.Unlimited

The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold on the mailbox items (all items or the mailbox items that are returned in the search query results). You use this parameter with the InPlaceHoldEnabled parameter to set an In-Place Hold. The duration is calculated from the time the item is received or created in the mailbox. Valid values are:

  • An integer.

  • The value unlimited. This is the default value. Items are held until you remove the In-Place Hold by one of the following actions:

    •  You remove the search by using the Remove-MailboxSearch cmdlet.

    •  You remove the source mailbox from the search by using the Set-MailboxSearch cmdlet and the SourceMailboxes parameter.

    •  In on-premises Exchange, you remove all public folders from the search by using the Set-MailboxSearch cmdlet to change the AllPublicFolderSources parameter from $true to $false.

Language

Optional

System.String

The Language parameter specifies a locale for the mailbox search.

Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, en for English or fr for French. For more information, see CultureInfo Class.

LogLevel

Optional

Microsoft.Exchange.Data.Storage.Infoworker.MailboxSearch.LoggingLevel

The LogLevel parameter specifies a logging level for the mailbox search. Valid values are:

  • Basic   Basic details of the search are kept. This is the default value.

  • Full   In addition to details in the Basic logging level, a full list of all messages returned is included.

  • Suppress   Logging is suppressed. No logs are kept.

MessageTypes

Optional

Microsoft.Exchange.Data.Search.AqsParser.KindKeyword[]

The MessageTypes parameter specifies the message types to include in the search query. Valid values are:

  • Contacts

  • Docs

  • Email

  • IM

  • Journals

  • Meetings

  • Notes

  • Tasks

You can specify multiple values separated by commas.

The default value is blank ($null), which means all message types are included. To clear all specified values, use the value $null.

Name

Optional

System.String

The Name parameter specifies a name for the search. If the value contains spaces, enclose the value in quotation marks (").

The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter.

PublicFolderSources

Optional

Microsoft.Exchange.Configuration.Tasks.PublicFolderIdParameter[]

This parameter is reserved for internal Microsoft use.

Recipients

Optional

System.String[]

The Recipients parameter specifies one or more recipients include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results.

You can specify multiple recipients separated by commas. If the value contains spaces, enclose the value in quotation marks (").

To clear the recipients, use the value $null.

SearchQuery

Optional

System.String

The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information about KQL, see Keyword Query Language syntax reference.

If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator.

The other search query parameters are:

  • EndDate

  • MessageTypes

  • Recipients

  • Senders

  • StartDate

Senders

Optional

System.String[]

The Senders parameter specifies one or more senders to include in the search query. Messages that have the specified sender are returned in the search results. Senders can include users, distribution groups (messages sent by members of the group), SMTP addresses, or domains.

You can specify multiple senders separated by commas. If the value contains spaces, enclose the value in quotation marks (").

To clear the senders, use the value $null.

SourceMailboxes

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The SourceMailboxes parameter specifies the mailboxes to be searched. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • Email address

  • GUID

You can specify multiple values separated by commas.

To use this parameter, the AllSourceMailboxes parameter needs to be $false (the default value).

To clear the source mailboxes, use the value $null.

noteNote:
To enable In-Place Hold on the search results, you need to set the AllSourceMailboxes parameter to $false (the default value) and configure one or both of the following settings:
  • Specify one or more source mailboxes by using the SourceMailboxes parameter.

  • In on-premises Exchange, set the AllPublicFolderSources parameter to $true.

StartDate

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The StartDate parameter specifies the start date of the date range.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".

To clear start date, use the value $null.

StatisticsStartIndex

Optional

System.Int32

The StatisticsStartIndex parameter is used by the Exchange admin center (EAC) to retrieve keyword statistics in a paged operation.

StatusMailRecipients

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The StatusMailRecipients parameter specifies one or more recipients to receive a status email message upon completion of the search. You can use any value that uniquely identifies the recipient.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • Email address

  • GUID

You can specify multiple values separated by commas.

TargetMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The TargetMailbox parameter specifies the destination mailbox where the search results are copied. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

WhatIf

Optional

System.Management.Automation.SwitchParameter

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.

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.

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.

 
Show: