Search-Mailbox

Ссылка

Модуль:: ExchangePowerShell

Применяется к:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.

Командлет Search-Mailbox используется для поиска по почтовым ящикам и копирования результатов в указанный целевой почтовый ящик, удаления сообщений из исходного почтового ящика или обеих задач сразу.

Примечание. В облачных средах командлет Search-Mailbox не рекомендуется использовать в пользу New-ComplianceSearch и связанных командлетов обнаружения электронных данных.

По умолчанию Search-Mailbox доступны только в ролях "Поиск почтовых ящиков" или "Экспорт импорта почтовых ящиков", и эти роли не назначаются ни одной группе ролей. Чтобы использовать этот командлет, необходимо добавить одну или обе роли в группу ролей (например, группу ролей "Управление организацией"). Доступ к параметру DeleteContent предоставляет только роль Экспорта импорта почтового ящика. Дополнительные сведения о добавлении ролей в группы ролей см. в разделе Добавление роли в группу ролей.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

Search-Mailbox
      [-Identity] <MailboxOrMailUserIdParameter>
      [-Confirm]
      [-DeleteContent]
      [-DomainController <Fqdn>]
      [-DoNotIncludeArchive]
      [-Force]
      [-IncludeUnsearchableItems]
      [-SearchDumpster]
      [-SearchDumpsterOnly]
      [-SearchQuery <String>]
      [-WhatIf]
      [<CommonParameters>]

Search-Mailbox
      [-Identity] <MailboxOrMailUserIdParameter>
      [-EstimateResultOnly]
      [-Confirm]
      [-DomainController <Fqdn>]
      [-DoNotIncludeArchive]
      [-Force]
      [-IncludeUnsearchableItems]
      [-SearchDumpster]
      [-SearchDumpsterOnly]
      [-SearchQuery <String>]
      [-WhatIf]
      [<CommonParameters>]

Search-Mailbox
      [-Identity] <MailboxOrMailUserIdParameter>
      -TargetFolder <String>
      -TargetMailbox <MailboxIdParameter>
      [-Confirm]
      [-DeleteContent]
      [-DomainController <Fqdn>]
      [-DoNotIncludeArchive]
      [-Force]
      [-IncludeUnsearchableItems]
      [-LogLevel <LoggingLevel>]
      [-LogOnly]
      [-SearchDumpster]
      [-SearchDumpsterOnly]
      [-SearchQuery <String>]
      [-WhatIf]
      [<CommonParameters>]

Описание

Командлет Search-Mailbox можно использовать для поиска сообщений в заданном почтовом ящике и выполнения любой из следующих задач:

Копирование сообщений в указанный целевой почтовый ящик.
Удаление сообщений из исходного почтового ящика. Для удаления сообщений вам должна быть назначена роль управления экспортом и импортом почтовых ящиков.
Выполнение восстановления отдельных элементов для восстановления элементов пользовательской папки "Элементы для восстановления".
Очистка папки "Элементы для восстановления" в почтовом ящике при достижении жесткой квоты.

Примеры

Пример 1

Search-Mailbox -Identity "Joe Healy" -SearchQuery "Subject:Project Hamilton" -TargetMailbox "DiscoveryMailbox" -TargetFolder "JoeHealy-ProjectHamilton" -LogLevel Full

В этом примере производится поиск по почтовому ящику Joe Healy и копируются результаты поиска в почтовый ящик DiscoveryMailbox в папку JoeHealy-ProjectHamilton.

Пример 2

Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -TargetMailbox "administrator" -TargetFolder "SearchAndDeleteLog" -LogOnly -LogLevel Full

В этом примере ведется поиск по почтовому ящику April Stewart с отбором сообщений, содержащих фразу "Your bank statement" в теме; результаты заносятся в папку SearchAndDeleteLog почтового ящика администратора. В целевой почтовый ящик сообщения не копируются.

Пример 3

Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -DeleteContent

В этом примере ведется поиск по почтовому ящику April Stewart с отбором сообщений, содержащих фразу "Your bank statement" в теме; сообщения удаляются из исходного почтового ящика. Для использования параметра DeleteContent вам должна быть назначена роль управления экспортом и импортом почтовых ящиков.

Пример 4

Get-Mailbox | Search-Mailbox -SearchQuery 'election OR candidate OR vote' -TargetMailbox "Discovery Search Mailbox" -TargetFolder "AllMailboxes-Election" -LogLevel Full

В этом примере выполняется поиск всех почтовых ящиков в организации на наличие сообщений, содержащих слова "election", "candidate" или "vote" (выборы, кандидат, голосование). Результаты поиска копируются в почтовый ящик поиска в папке AllMailboxes-Election.

Параметры

-Confirm

Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.

Деструктивные командлеты (например, командлеты Remove-*) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис: -Confirm:$false.
Большинство других командлетов (например, командлеты New-* и Set-*) не имеют встроенной приостановки. Для этих командлетов указание переключателя 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

-DeleteContent

Примечание. Для использования этого параметра необходимо назначить роль управления экспортом импорта почтовых ящиков. По умолчанию эта роль не назначается ни одной группе ролей (включая управление организацией). Как правило, роль назначается предопределенной или пользовательской группе ролей.

Параметр DeleteContent указывает, что сообщения, возвращаемые при поиске, должны быть безвозвратно удалены из исходного почтового ящика. Для этого переключателя не требуется указывать значение.

При использовании этого параметра с параметром TargetMailbox сообщения копируются в целевой почтовый ящик и удаляются из исходного почтового ящика. Если задать для поиска уровень ведения журнала Basic или Full, следует указать целевой почтовый ящик и целевую папку, в которой будет создан журнал. Чтобы удалить сообщения из исходного ящика без копирования в целевой почтовый ящик, не задавайте значения параметров TargetMailbox, TargetFolder и LogLevel.

Перед использованием параметра DeleteContent для удаления содержимого рекомендуется проверить параметры подключения с помощью параметра LogOnly, как показано в примере 2.

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

-DomainController

Этот параметр доступен только в локальной среде Exchange.

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в 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

Параметр DoNotIncludeArchive указывает, что архивный почтовый ящик пользователя не должен включаться в поиск. С этим параметром не нужно указывать значение.

По умолчанию архивный почтовый ящик всегда включается в поиск.

Если для почтового ящика Exchange Online включено автоматическое расширение, выполняется поиск только в основном архивном почтовом ящике пользователя. Дополнительные архивные почтовые ящики не включаются в поиск.

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

-EstimateResultOnly

Параметр EstimateResultOnly возвращает только оценку общего количества и размера сообщений. В целевой почтовый ящик сообщения не копируются. Указывать значение для этого параметра необязательно.

Этот параметр невозможно использовать с параметром TargetMailbox.

Type:	SwitchParameter
Position:	Named
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

-Force

Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.

Используйте этот параметр, чтобы скрыть запрос на подтверждение при использовании параметра DeleteContent для окончательного удаления сообщений.

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

-Identity

Параметр Identity указывает идентификатор почтового ящика для поиска. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.

Имя
Псевдоним
различающееся имя (DN);
различающееся имя (DN);
Домен\Имя пользователя
Адрес электронной почты
GUID
LegacyExchangeDN
SamAccountName
Идентификатор пользователя или имя участника-пользователя

Type:	MailboxOrMailUserIdParameter
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, 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

-LogLevel

Параметр LogLevel указывает уровень ведения журнала для поиска. Можно использовать одно из следующих значений:

Подавление: журналы не хранятся.
Базовый. Основные сведения о запросе и о том, кто его выполнил, сохраняются.
Полное. Помимо сведений, хранящихся на уровне базового журнала, уровень полного журнала добавляет полный список результатов поиска.

Уровень журнала по умолчанию равен Basic.

Если вы включили этот параметр, создается сообщение электронной почты и отправляется в почтовый ящик, указанный параметром TargetMailbox. Файл журнала (который является файлом в формате CSV с именем Search Results.csv) прикрепляется к этому сообщению электронной почты и будет находиться в папке, указанной параметром TargetFolder. Файл журнала содержит строку для каждого сообщения, которое включается в результаты поиска при выполнении командлета Search-Mailbox.

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

-LogOnly

Параметр LogOnly выполняет поиск, но создает только журнал. Сообщения, возвращенные в ходе поиска, не копируются в целевой почтовый ящик. Указывать значение для этого параметра необязательно.

Уровень ведения журнала задается параметром LogLevel.

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

-SearchDumpster

Параметр SearchDumpster указывает, следует ли включать в поиск папку "Элементы с возможностью восстановления". В папке "Элементы с возможностью восстановления" хранятся элементы, удаленные из папки "Удаленные", или элементы, которые были удалены жестко, пока они не будут удалены из базы данных почтового ящика.

По умолчанию в поиск всегда включена папка "Элементы с возможностью восстановления". Чтобы исключить папку "Элементы с возможностью восстановления" из поиска, используйте следующий синтаксис: -SearchDumpster:$false.

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

-SearchDumpsterOnly

Параметр SearchDumpsterOnly указывает, что выполняется поиск только в папке "Элементы с возможностью восстановления" указанного почтового ящика. Указывать значение для этого параметра необязательно.

В папке "Элементы с возможностью восстановления" хранятся элементы, удаленные из папки "Удаленные", или элементы, которые были удалены жестко, пока они не будут удалены из базы данных почтового ящика.

Также можно использовать этот параметр с параметром DeleteContent, чтобы удалить сообщения из этой папки и уменьшить ее размер.

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

-SearchQuery

Параметр SearchQuery указывает строку поиска или запрос, отформатированный с помощью языка запросов ключевых слов (KQL). Дополнительные сведения о KQL в Exchange см. в разделе Свойства сообщений и операторы поиска для In-Place обнаружения электронных данных.

Если параметр не задан, возвращаются все сообщения.

Примечание. Командлет Search-Mailbox возвращает до 10 000 результатов на почтовый ящик, если указан поисковый запрос.

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

-TargetFolder

Параметр TargetFolder задает имя папка, в которой в целевом почтовом ящике сохраняются результаты поиска. Папка создается в целевом почтовом ящике после выполнения.

Type:	String
Position:	Named
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

-TargetMailbox

Параметр TargetMailbox указывает почтовый ящик назначения, в который копируются результаты поиска. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.

Имя
Псевдоним
различающееся имя (DN);
различающееся имя (DN);
Домен\Имя пользователя
Адрес электронной почты
GUID
LegacyExchangeDN
SamAccountName
Идентификатор пользователя или имя участника-пользователя

Этот параметр необходимо использовать вместе с параметром TargetFolder. Данный параметр невозможно использовать совместно с параметром EstimateResultOnly.

Type:	MailboxIdParameter
Position:	Named
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

-WhatIf

Переключатель WhatIf имитирует действия команды. Вы можете использовать его для просмотра результатов изменений без фактического внесения этих изменений. С этим параметром не нужно указывать значение.

Type:	SwitchParameter
Aliases:	wi
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

Входные данные

Input types

Сведения о типах входных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип ввода для командлета пустое, командлет не принимает входные данные.

Выходные данные

Output types

Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.