Get-Message
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.
Syntax
Get-Message
[-Filter <String>]
[-BookmarkIndex <Int32>]
[-BookmarkObject <ExtensibleMessageInfo>]
[-IncludeBookmark <Boolean>]
[-IncludeComponentLatencyInfo]
[-IncludeRecipientInfo]
[-ResultSize <Unlimited>]
[-ReturnPageInfo <Boolean>]
[-SearchForward <Boolean>]
[-Server <ServerIdParameter>]
[-SortOrder <QueueViewerSortOrderEntry[]>]
[<CommonParameters>]Get-Message
[[-Identity] <MessageIdentity>]
[-BookmarkIndex <Int32>]
[-BookmarkObject <ExtensibleMessageInfo>]
[-IncludeBookmark <Boolean>]
[-IncludeComponentLatencyInfo]
[-IncludeRecipientInfo]
[-ResultSize <Unlimited>]
[-ReturnPageInfo <Boolean>]
[-SearchForward <Boolean>]
[-SortOrder <QueueViewerSortOrderEntry[]>]
[<CommonParameters>]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 tópico 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-ListEste 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 SCL maior que 3.
Exemplo 3
Get-Message -Server Server01.contoso.com -SortOrder: +FromAddress,-SizeEste 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.
| Type: | Int32 |
| 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 |
-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.
| Type: | ExtensibleMessageInfo |
| 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 |
-Filter
O parâmetro Filter especifica uma ou mais mensagens usando a sintaxe do filtro OPATH. O filtro OPATH inclui um nome de propriedade de mensagem seguido por um operador de comparação e valor (por exemplo, "FromAddress -like '*@contoso.com'"). Para obter detalhes sobre propriedades de mensagem filtradas 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 (").
| 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 |
-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.
| Type: | MessageIdentity |
| Position: | 1 |
| 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 |
-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.
| Type: | Boolean |
| 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 |
-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 incluir esta opção, os objetos da mensagem retornada incluirão medidas de latência para cada componente de transporte que tenha contribuído para a latência do servidor local para cada mensagem na fila.
| 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 |
-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 Completo, Pronto ou Repetir.
- 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 do destinatário de uma mensagem na contoso.com fila de entrega remota 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.
| 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 |
-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, Mailbox01\contoso.com ou Unreachable. Para obter detalhes sobre a identidade da fila, confira 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.
| Type: | QueueIdentity |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-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.
| Type: | Unlimited |
| 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 |
-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.
| Type: | Boolean |
| 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 |
-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.
| Type: | Boolean |
| 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 |
-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.
| Type: | ServerIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-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.
| Type: | QueueViewerSortOrderEntry[] |
| 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 |
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.