Search-Mailbox

Módulo:: Exchange PowerShell

Este cmdlet está disponível somente no Exchange local.

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 foi preterido em favor de New-ComplianceSearch e cmdlets de Descoberta Eletrônica relacionados.

Por padrão, Search-Mailbox está disponível apenas nas funções Pesquisa de Caixa de Correio ou Exportação de Importação de Caixa de Correio, 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 da Organização). Somente a função Exportação Importação da 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.

Sintaxe

Identity

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

EstimateResult

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

Mailbox

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. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.

Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
A maioria dos outros cmdlets (por exemplo, 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 reconhecer o comando antes de continuar.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	cf

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-DeleteContent

Observação: você precisa ter a função de gerenciamento Importação Exportação da 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 da Organização). 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.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Mailbox

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

Identity

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-DomainController

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.

Propriedades do parâmetro

Tipo:	Fqdn
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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 do Exchange Online, somente a caixa de correio de arquivo morto principal do usuário será pesquisada. As caixas de correio de arquivo morto auxiliares não são incluídas na pesquisa.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

EstimateResult

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Force

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

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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)
Domínio\Nome de usuário
Endereço de email
GUID
LegacyExchangeDN
SamAccountName
ID de usuário ou nome UPN

Propriedades do parâmetro

Tipo:	MailboxOrMailUserIdParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	1
Obrigatório:	True
Valor do pipeline:	True
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-IncludeUnsearchableItems

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-LogLevel

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

Suprimir: nenhum registro é 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ê inclui 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 em CSV chamado Pesquisa Results.csv) está anexado a essa mensagem de email e está 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.

Propriedades do parâmetro

Tipo:	LoggingLevel
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Mailbox

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-LogOnly

O comutador 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.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Mailbox

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-SearchDumpster

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

Por padrão, a pasta Itens Recuperáveis está sempre incluída na pesquisa. Para excluir a pasta Itens Recuperáveis da pesquisa, use exatamente esta sintaxe: -SearchDumpster:$false.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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 irreversivelmente até serem 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.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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 KQL no Exchange, consulte Propriedades de 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é 10000 resultados por caixa de correio se uma consulta de pesquisa for especificada.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

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

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Mailbox

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-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)
Domínio\Nome de usuário
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.

Propriedades do parâmetro

Tipo:	MailboxIdParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Mailbox

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-WhatIf

A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. Não é preciso especificar um valor com essa opção.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	wi

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

CommonParameters

Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.

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.

Comentários

Esta página foi útil?