Search-Mailbox

Referência

Módulo:: ExchangePowerShell

Aplica-se a:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.

Use o cmdlet Search-Mailbox para pesquisar uma caixa de correio e copiar os resultados para uma caixa de correio de destino especificada, excluir mensagens da caixa de correio de origem, ou ambos.

Observação: em ambientes baseados em nuvem, o cmdlet Search-Mailbox está sendo preterido em favor de cmdlets new-complianceSearch e eDiscovery relacionados.

Por padrão, Search-Mailbox está disponível apenas nas funções Pesquisa de Caixa de Correio ou Importação de Caixa de Correio Exportar, e essas funções não são atribuídas a nenhum grupo de funções. Para usar esse cmdlet, você precisa adicionar uma ou ambas as funções a um grupo de funções (por exemplo, o grupo de funções gerenciamento de organização). Somente a função Exportação de Importação de Caixa de Correio fornece acesso ao parâmetro DeleteContent. Para obter mais informações sobre como adicionar funções a grupos de funções, consulte Adicionar uma função a um grupo de funções.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

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>]

Description

Você pode usar o cmdlet Search-Mailbox para pesquisar mensagens em uma caixa de correio especificada e desempenhar quaisquer uma das seguintes tarefas:

Copiar mensagens para uma caixa de correio de destino especificada.
Excluir mensagens da caixa de correio de origem. Você deve receber a atribuição de função de gerenciamento Importar Exportar Caixa de Correio para excluir mensagens.
Desempenhar recuperação de item única para recuperar itens de uma pasta de Itens Recuperáveis do usuário.
Limpar a pasta Itens Recuperáveis para uma caixa de correio quando ela alcançar a cota fixa de Itens Recuperáveis.

Exemplos

Exemplo 1

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

Este exemplo pesquisa a caixa de correio de Joe Healy e copia os resultados da pesquisa em DiscoveryMailbox na pasta JoeHealy-ProjectHamilton.

Exemplo 2

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

Este exemplo pesquisa a caixa de correio de April Stewart em busca de mensagens que contenham a frase "Your bank statement" no assunto e registra o resultado em log na pasta SearchAndDeleteLog, na caixa de correio do administrador. As mensagens não são copiadas para a caixa de correio de destino.

Exemplo 3

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

Este exemplo pesquisa a caixa de correio de April Stewart em busca de mensagens que contenham a frase "Your bank statement" no assunto e exclui as mensagens da caixa de correio de origem. Você precisa receber a atribuição da função de gerenciamento Importar Exportar Caixa de Correio para usar a opção DeleteContent.

Exemplo 4

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

Este exemplo pesquisa todas as caixas de correio na sua organização por mensagens que contenham as palavras "election", "candidate" ou "vote". Os resultados da pesquisa serão copiados para a Caixa de Correio de Pesquisa de Descoberta na pasta AllMailboxes-Election.

Parâmetros

-Confirm

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.

Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o comando antes de continuar.

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

Observação: você precisa receber a função de Gerenciamento de Exportação de Importação de Caixa de Correio para usar essa opção. Por padrão, essa função não é atribuída a nenhum grupo de funções (incluindo o Gerenciamento de Organizações). Normalmente, você pode atribuir uma função a um grupo de funções internas ou personalizadas.

A opção DeleteContent especifica que as mensagens retornadas pela pesquisa sejam permanentemente excluídas da caixa de correio de origem. Não é preciso especificar um valor com essa opção.

Quando você usa essa opção com o parâmetro TargetMailbox, as mensagens são copiadas para a caixa de correio de destino e removidas da caixa de correio de origem. Se o nível de registro em log for definido para a pesquisa como Basic ou Full, uma caixa de correio de destino e uma pasta de destino devem ser especificadas para armazenar o log. Para excluir mensagens da caixa de correio de origem sem copiá-las para a caixa de correio de destino, não especifique os parâmetros TargetMailbox, TargetFolder e LogLevel.

Antes de usar a opção DeleteContent para excluir conteúdo, é recomendável testar parâmetros de pesquisa usando o parâmetro LogOnly, como mostra o Exemplo 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

Este parâmetro está disponível somente no Exchange local.

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, 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

A opção DoNotIncludeArchive especifica que a caixa de correio de arquivo morto do usuário não deve ser incluída na pesquisa. Não é necessário especificar um valor para esta opção.

Por padrão, a caixa de correio de arquivo morto sempre é pesquisada.

Se o arquivamento de expansão automática estiver habilitado para uma caixa de correio Exchange Online, somente a caixa de correio de arquivo principal do usuário será pesquisada. As caixas de correio de arquivo morto auxiliares não são incluídas na pesquisa.

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

A opção EstimateResultOnly retorna apenas uma estimativa do número total e do tamanho das mensagens. As mensagens não são copiadas para a caixa de correio de destino. Não é preciso especificar um valor com essa opção.

Não é possível usar essa opção com o parâmetro 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

A opção Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.

Use essa opção para ocultar o prompt de confirmação ao usar a opção DeleteContent para excluir mensagens permanentemente.

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

O parâmetro Identity especifica a identidade da caixa de correio de pesquisa. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

Nome
Alias
Nome diferenciado (DN)
Nome diferenciado (DN)
Domain\username
Endereço de email
GUID
LegacyExchangeDN
SamAccountName
ID de usuário ou nome UPN

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

A opção IncludeUnsearchableItems inclui itens que não puderam ser indexados pelo Exchange Search nos resultados da pesquisa. Não é preciso especificar um valor com essa opção.

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

O parâmetro LogLevel especifica o nível do registro em log da pesquisa. Pode ter um dos seguintes valores:

Supressão: nenhum log é mantido.
Básico: as informações básicas sobre a consulta e quem a executou são mantidas.
Completo: além das informações mantidas pelo nível de log básico, o nível de log completo adiciona uma lista completa de resultados da pesquisa.

O nível de log padrão é Basic.

Quando você incluiu esse parâmetro, uma mensagem de email é criada e enviada para a caixa de correio especificada pelo parâmetro TargetMailbox. O arquivo de log (que é um arquivo formatado por CSV chamado Search Results.csv) está anexado a essa mensagem de email e estará localizado na pasta especificada pelo parâmetro TargetFolder. O arquivo de log contém uma linha para cada mensagem incluída nos resultados da pesquisa quando você executa o cmdlet 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

A opção LogOnly executa uma pesquisa, mas só gera um log. As mensagens retornadas pela pesquisa não são copiadas para a caixa de correio de destino. Não é preciso especificar um valor com essa opção.

O nível de registro em log é especificado usando o parâmetro 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

A opção SearchDumpster especifica se deve incluir a pasta Itens Recuperáveis na pesquisa. A pasta itens recuperáveis armazena itens que foram excluídos da pasta Itens Excluídos ou itens que foram excluídos duramente até que sejam removidos do banco de dados da caixa de correio.

Por padrão, a pasta Itens Recuperáveis é sempre incluída na pesquisa. Para excluir a pasta Itens Recuperáveis da pesquisa, use esta sintaxe exata: -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

A opção SearchDumpsterOnly especifica que apenas a pasta Itens Recuperáveis da caixa de correio especificada é pesquisada. Não é preciso especificar um valor com essa opção.

A pasta itens recuperáveis armazena itens que foram excluídos da pasta Itens Excluídos ou itens que foram excluídos duramente até que sejam removidos do banco de dados da caixa de correio.

Também é possível utilizá-la com a opção DeleteContent para excluir mensagens da pasta Itens Recuperáveis e reduzir o tamanho da pasta.

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

O parâmetro SearchQuery especifica uma sequência de caracteres para pesquisa ou uma consulta formatada usando a Linguagem de Consulta de Palavra-chave (KQL). Para obter mais informações sobre o KQL no Exchange, consulte Propriedades da mensagem e operadores de pesquisa para In-Place descoberta eletrônica.

Se esse parâmetro estiver vazio, todas as mensagens serão retornadas.

Observação: o cmdlet Search-Mailbox retorna até 10.000 resultados por caixa de correio se uma consulta de pesquisa for especificada.

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

O parâmetro TargetFolder especifica um nome de pasta onde os resultados da pesquisa são salvos na caixa de correio de destino. A pasta é criada na caixa de correio de destino durante a execução.

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

O parâmetro TargetMailbox especifica a caixa de correio de destino em que os resultados da pesquisa são copiados. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

Nome
Alias
Nome diferenciado (DN)
Nome diferenciado (DN)
Domain\username
Endereço de email
GUID
LegacyExchangeDN
SamAccountName
ID de usuário ou nome UPN

Você deve usar esse parâmetro com o parâmetro TargetFolder. Não é possível usar esse parâmetro com a opção 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

A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.

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

Entradas

Input types

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.