Get-Message

Módulo:: Exchange PowerShell

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

Use o cmdlet Get-Message para exibir os detalhes de uma ou mais mensagens nas filas dos servidores de Caixa de Correio ou de Transporte de Borda.

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

Sintaxe

Filter

Get-Message
    [-Filter <String>]
    [-BookmarkIndex <Int32>]
    [-BookmarkObject <ExtensibleMessageInfo>]
    [-IncludeBookmark <Boolean>]
    [-IncludeComponentLatencyInfo]
    [-IncludeRecipientInfo]
    [-ResultSize <Unlimited>]
    [-ReturnPageInfo <Boolean>]
    [-SearchForward <Boolean>]
    [-Server <ServerIdParameter>]
    [-SortOrder <QueueViewerSortOrderEntry[]>]
    [<CommonParameters>]

Identity

Get-Message
    [[-Identity] <MessageIdentity>]
    [-BookmarkIndex <Int32>]
    [-BookmarkObject <ExtensibleMessageInfo>]
    [-IncludeBookmark <Boolean>]
    [-IncludeComponentLatencyInfo]
    [-IncludeRecipientInfo]
    [-ResultSize <Unlimited>]
    [-ReturnPageInfo <Boolean>]
    [-SearchForward <Boolean>]
    [-SortOrder <QueueViewerSortOrderEntry[]>]
    [<CommonParameters>]

Queue

Get-Message
    [-Queue <QueueIdentity>]
    [-BookmarkIndex <Int32>]
    [-BookmarkObject <ExtensibleMessageInfo>]
    [-IncludeBookmark <Boolean>]
    [-IncludeComponentLatencyInfo]
    [-IncludeRecipientInfo]
    [-ResultSize <Unlimited>]
    [-ReturnPageInfo <Boolean>]
    [-SearchForward <Boolean>]
    [-SortOrder <QueueViewerSortOrderEntry[]>]
    [<CommonParameters>]

Description

Para exibir mensagens, inclua o nome do servidor como parte do parâmetro Identity ou do Queue, ou inclua o parâmetro Server com uma consulta de filtro. As configurações dos parâmetros Identity, Queue e Filter são mutuamente exclusivos.

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

Get-Message -Filter "FromAddress -like '*@contoso.com'" | Format-List

Este exemplo exibe informações detalhadas sobre todas as mensagens em fila no servidor local e recebidas de qualquer remetente no domínio contoso.com.

Exemplo 2

Get-Message -Filter "FromAddress -like '*@contoso.com' -and SCL -gt 3"

Este exemplo lista todas as mensagens enfileiradas no servidor local, recebidas de qualquer remetente no domínio contoso.com e que têm um valor de SCL maior que 3.

Exemplo 3

Get-Message -Server Server01.contoso.com -SortOrder: +FromAddress,-Size

Este exemplo mostra todas as mensagens em fila no servidor chamado Server01. Os resultados são classificados primeiro em ordem crescente por endereço do remetente e, em seguida, em ordem decrescente de tamanho.

Parâmetros

-BookmarkIndex

O parâmetro BookmarkIndex especifica a posição no conjunto de resultados, no local de início dos resultados exibidos. O valor deste parâmetro é um índice baseado em 1 no conjunto de resultados total. O parâmetro BookmarkIndex não pode ser usado com o parâmetro BookmarkObject.

Propriedades do parâmetro

Tipo:	Int32
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

-BookmarkObject

O parâmetro BookmarkObject especifica o objeto no conjunto de resultados, no local de início dos resultados exibidos. O parâmetro BookmarkObject não pode ser usado com o parâmetro BookmarkIndex.

Propriedades do parâmetro

Tipo:	ExtensibleMessageInfo
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

-Filter

O parâmetro Filter especifica uma ou mais mensagens usando a sintaxe de filtro OPATH. O filtro OPATH inclui um nome de propriedade de mensagem seguido por um operador de comparação e um valor (por exemplo, "FromAddress -like '*@contoso.com'"). Para obter detalhes sobre propriedades de mensagens filtráveis e operadores de comparação, consulte Propriedades de mensagens em filas e Localizar filas e mensagens em filas no Shell de Gerenciamento do Exchange.

Você pode especificar vários critérios usando o operador de comparação e. Os valores de propriedade não expressos como um inteiro devem ficar entre aspas (").

Propriedades do parâmetro

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

Conjuntos de parâmetros

Filter

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 mensagem. A entrada válida para esse parâmetro usa a sintaxe Server\Queue\MessageInteger ou Queue\MessageInteger ou MessageInteger, por exemplo, Mailbox01\contoso.com\5 ou 10. Para obter detalhes sobre a identidade da mensagem, consulte Identidade da mensagem.

Cuidado: O valor $null ou um valor inexistente para o parâmetro Identity retorna todos os objetos como se você tivesse executado o comando Get- sem o parâmetro Identity. Verifique se todas as listas de valores para o parâmetro Identity são precisas e não contêm valores de $null inexistentes.

Propriedades do parâmetro

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

Conjuntos de parâmetros

Identity

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

-IncludeBookmark

O parâmetro IncludeBookmark especifica se é necessário incluir o objeto indicador, quando os resultados da consulta são exibidos. O parâmetro IncludeBookmark é válido quando usado com os parâmetros BookmarkObject ou BookmarkIndex. Caso você não especifique um valor para o parâmetro IncludeBookmark, será usado o valor padrão de $true.

Propriedades do parâmetro

Tipo:	Boolean
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

-IncludeComponentLatencyInfo

A opção IncludeComponentLatencyInfo especifica se as informações sobre latência de componente é incluída nas propriedades da mensagem. Não é preciso especificar um valor com essa opção.

Se você incluir essa opção, os objetos de mensagem retornados incluirão medidas de latência para cada componente de transporte que contribuiu para a latência do servidor local para cada mensagem na fila.

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

-IncludeRecipientInfo

O parâmetro IncludeRecipientInfo especifica se exibe ou não os destinatários de mensagem no campo Destinatários. Não é preciso especificar um valor com essa opção.

Se você não incluir o parâmetro IncludeRecipientInfo, o campo Destinatários ficará em branco.

Armazenar os resultados de um Get-Message -IncludeRecipientInfo comando em uma variável permite exibir propriedades adicionais para os destinatários da mensagem. A lista a seguir descreve as propriedades de destinatários disponíveis:

Endereço: O endereço de email do destinatário.
Tipo: o tipo de destinatário, que pode ser Externo, Caixa de Correio ou Grupo de Distribuição. O Grupo de distribuição é usado quando o destino é um servidor de expansão.
FinalDestination: O DN (nome diferenciado) do objeto usado para rotear a mensagem.
Status: o status do destinatário pode ser Concluído, Pronto ou Tentar novamente.
LastError: A resposta SMTP após a última tentativa de entrega ou uma mensagem de erro localizada, se a mensagem for colocada na fila de mensagens inacessíveis.

Por exemplo, para armazenar as informações de destinatário de uma mensagem na fila de entrega remota contoso.com que tem o valor MessageIdentity de 1234 para uma variável chamada $x, use o seguinte comando: $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo.

Para exibir as propriedades estendidas do destinatário que agora estão armazenadas na variável $x, use o seguinte comando: $x.Recipients.

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

-Queue

O parâmetro Queue especifica a identidade da fila que contém as mensagens que deseja exibir. A entrada válida para esse parâmetro usa a sintaxe <Server>\<Queue> ou <Queue>, por exemplo, Caixa de correio01\contoso.com ou Inacessível. Para obter detalhes sobre a identidade da fila, consulte a seção "Identidade da fila" em Localizar filas e mensagens em filas no Shell de Gerenciamento do Exchange.

Se o parâmetro Queue for utilizado, não será possível usar os parâmetros Identity, Filter ou Server.

Propriedades do parâmetro

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

Conjuntos de parâmetros

Queue

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

-ResultSize

O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.

Propriedades do parâmetro

Tipo:	Unlimited
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

-ReturnPageInfo

O parâmetro ReturnPageInfo é oculto. Use-o para retornar informações sobre o número total de resultados e o índice do primeiro objeto da página atual. O valor padrão é $false.

Propriedades do parâmetro

Tipo:	Boolean
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

-SearchForward

O parâmetro SearchForward especifica se devemos pesquisar para frente ou para trás no conjunto de resultados. O valor padrão é $true. Este valor faz com que a página de resultados seja calculada para frente a partir do início do conjunto de resultados ou a partir de um indicador, caso seja fornecido.

Propriedades do parâmetro

Tipo:	Boolean
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

-Server

O parâmetro Servidor especifica o servidor Exchange em que você deseja executar esse comando. É possível usar qualquer valor que identifique o servidor com exclusividade. Por exemplo:

Nome
FQDN
DN (nome diferenciado)
DN Herdado do Exchange

DN Herdado do Exchange

Use o parâmetro Server e o parâmetro Filter no mesmo comando. Não é possível usar o parâmetro Server e o parâmetro Identity no mesmo comando.

Propriedades do parâmetro

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

Conjuntos de parâmetros

Filter

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

-SortOrder

O parâmetro SortOrder especifica uma matriz de propriedades de mensagem usadas para controlar a ordem de classificação do conjunto de resultados. Separe cada propriedade por vírgula. Acrescente um sinal de mais (+) ao início do nome da propriedade para exibir os resultados na ordem crescente. Acrescente um sinal de menos (-) ao início do nome da propriedade para exibir os resultados na ordem decrescente.

Se você não especificar uma ordem de classificação, o conjunto de resultados será exibido em ordem crescente pelo número inteiro de MessageIdentity.

Propriedades do parâmetro

Tipo:	QueueViewerSortOrderEntry[]
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

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?