Compartilhar via

Get-Message

  • Artigo

 

Aplica-se a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Tópico modificado em: 2007-08-29

Use o cmdlet Get-Message para exibir os detalhes de uma ou mais mensagens em uma fila de um computador em que a função de servidor Transporte de Hub ou de Transporte de Borda esteja instalada.

Sintaxe

Get-Message [-BookmarkIndex <Int32>] [-BookmarkObject <MessageInfo>] [-Filter <String>] [-IncludeBookmark <$true | $false>] [-IncludeRecipientInfo <SwitchParameter>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-Server <ServerIdParameter>] [-SortOrder <SortOrderEntry[]>]

Get-Message [-Identity <MessageIdentity>] [-BookmarkIndex <Int32>] [-BookmarkObject <MessageInfo>] [-IncludeBookmark <$true | $false>] [-IncludeRecipientInfo <SwitchParameter>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-SortOrder <SortOrderEntry[]>]

Get-Message [-BookmarkIndex <Int32>] [-BookmarkObject <MessageInfo>] [-IncludeBookmark <$true | $false>] [-IncludeRecipientInfo <SwitchParameter>] [-Queue <QueueIdentity>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-SortOrder <SortOrderEntry[]>]

Descrição detalhada

O cmdlet Get-Message exibe os detalhes de uma ou mais mensagens que estão em uma fila existente no servidor de Transporte de Hub ou de Transporte de Borda. Se você não fornecer parâmetros, o comando consultará todas as mensagens em qualquer fila do servidor local e retornará uma única página de resultados. O tamanho de página padrão é de 1.000 objetos. Para exibir mensagens em um servidor remoto, inclua o nome do servidor como parte do parâmetro Identity ou do parâmetro Queue, ou inclua o parâmetro Server com uma consulta de filtro. Os parâmetros Identity, Queue e Filter são mutuamente exclusivos.

Para executar o cmdlet Get-Message, você deve usar uma conta à qual esteja delegada a função de Administrador do Exchange Server.

Para executar o cmdlet Get-Message em um computador em que a função de servidor Transporte de Borda esteja instalada, você deve fazer logon usando uma conta que seja membro do grupo Administradores local no mesmo computador.

Para obter mais informações sobre permissões, delegação de funções e os direitos necessários para administrar o Microsoft Exchange Server 2007, consulte Considerações sobre permissão.

Parâmetros

Parâmetro Necessário Tipo Descrição

BookmarkIndex

Opcional

System.Int32

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

BookmarkObject

Opcional

Microsoft.Exchange.Data.QueueViewer.MessageInfo

Use o parâmetro BookmarkObject para especificar o objeto no conjunto de resultados em que os resultados exibidos começam. BookmarkObject não pode ser usado com o parâmetro BookmarkIndex.

Filter

Opcional

System.String

O parâmetro Filter requer uma expressão que especifique os critérios de valor de propriedade para as mensagens a serem exibidas. A expressão inclui um nome de propriedade que é seguido de um operador de comparação e um valor. As seguintes propriedades da mensagem são critérios válidos para o parâmetro Filter:

  • DateReceived   A data em que a mensagem foi recebida.

  • ExpirationTime   A hora em que uma mensagem irá expirar.

  • FromAddress   O endereço SMTP do remetente de uma mensagem. Esse valor é obtido de MAIL FROM: no envelope da mensagem.

  • Identity   Um número inteiro que representa uma determinada mensagem e uma identidade opcional de servidor e fila.

  • InternetMessageId   O valor do campo de cabeçalho Message-ID:. Esta propriedade é expressa como uma GUID seguida do endereço SMTP de um servidor remetente, como neste exemplo: 67D7543D6103DC4FBEBA6BC7205DACABA61231@exchange.contoso.com.

  • LastError   Uma cadeia de texto que representa o último erro registrado para uma mensagem.

  • MessageSourceName   Uma cadeia de texto que representa o nome do componente que enviou esta mensagem para a fila.

  • Queue   Especifica a identidade da fila que contém a mensagem. Insira a identidade da fila no formato Servidor\destino, onde destino é um domínio remoto, um servidor de caixas de correio ou um nome de fila persistente.

  • RetryCount   O número de tentativas de entrega de uma mensagem para um destino.

  • SCL   A propriedade SCL especifica o nível de confiança de spam da mensagem. Entradas SCL válidas são números inteiros de 0 a 9. Um valor de propriedade SCL vazio indica que a mensagem não foi processada pelo agente de Filtro de Conteúdo.

  • Size   O tamanho de uma mensagem.

  • SourceIP   O endereço IP do servidor externo que enviou a mensagem para a organização do Exchange.

  • Status   O status atual da mensagem. As opções de status da mensagem são Active, Retry, Suspended, PendingSuspend ou PendingRemove.

  • Subject   Uma cadeia de texto que representa o assunto do email. O valor é obtido do campo de cabeçalho Subject:.

Você pode especificar diversos critérios de filtragem por meio do operador de comparação - and. Os valores de propriedades que não são expressos como um único número inteiro devem ficar entre aspas.

Identity

Opcional

Microsoft.Exchange.Data.QueueViewer.MessageIdentity

Use o parâmetro Identity para especificar inteiro MessageIdentity. Esse é um número inteiro que representa uma determinada mensagem e uma identidade de servidor e de fila opcional. A sintaxe desse parâmetro pode ser especificada da seguinte maneira:

  • Server\QueueIdentity\MessageIdentity

  • QueueIdentity\MessageIdentity

  • Server\*\MessageIdentity

  • MessageIdentity

IncludeBookmark

Opcional

System.Boolean

Use o parâmetro IncludeBookmark para especificar se deseja incluir o objeto indicador quando os resultados da consulta forem exibidos. O parâmetro IncludeBookmark é válido quando é usado com os parâmetros BookmarkObject ou BookmarkIndex. Se você não especificar um valor para o parâmetro IncludeBookmark, será usado o valor padrão $true.

IncludeRecipientInfo

Opcional

System.Management.Automation.SwitchParameter

Use o parâmetro IncludeRecipientInfo para exibir os destinatários de mensagem no campo Destinatários. Se você não incluir o parâmetro IncludeRecipientInfo, o campo Destinatários ficará em branco.

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

  • Address   O endereço de email do destinatário.

  • Type   O tipo de destinatário pode ser Externo, Caixa de correio ou DL. O tipo DL é usado quando o destino é um servidor de expansão.

  • FinalDestination   O DN (nome distinto) do objeto usado para rotear a mensagem. O objeto pode ser um conector, um servidor de caixa de correio ou um servidor de expansão.

  • Status   O status do destinatário pode ser Concluído, 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 fila de entrega remota "Contoso.com" cujo valor de MessageIdentity é 1234 para uma variável nomeada $x, use o seguinte comando:

$x=Get-Message -Identity "Contoso.com\1234" -IncludeRecipientInfo

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

$x.Recipients

Queue

Opcional

Microsoft.Exchange.Data.QueueViewer.QueueIdentity

Use o parâmetro Queue para especificar a identidade da fila que contém as mensagens que deseja exibir. Insira a identidade da fila no formato Servidor\destino, onde destino é um domínio remoto, um servidor de caixas de correio ou um nome de fila persistente.

ResultSize

Opcional

Microsoft.Exchange.Data.Unlimited

Use o parâmetro ResultSize para especificar o número total de itens a serem exibidos no painel de resultados. O valor padrão do parâmetro ResultSize é definido como 1.000. ResultSize dá suporte a um número ilimitado de resultados, mas Microsoft Exchange limita o conjunto de resultados a 250.000.

ReturnPageInfo

Opcional

System.Boolean

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.

SearchForward

Opcional

System.Boolean

Use o parâmetro SearchForward para especificar se deseja 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.

Server

Opcional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

Use o parâmetro Server para especificar o nome do servidor ao qual se conectar por meio de uma chamada de procedimento remoto (RPC) que contenha as filas das mensagens que você deseja exibir. Insira o parâmetro Server como um nome de host ou um nome de domínio totalmente qualificado (FQDN). Se esse parâmetro não for usado, será consultado o servidor local.

SortOrder

Opcional

Microsoft.Exchange.Configuration.Tasks.SortOrderEntry[]

Use o parâmetro SortOrder para especificar uma matriz de propriedades de mensagens usadas para controlar a ordem de classificação do conjunto de resultados. Separe cada propriedade por vírgula. Acrescente um símbolo + ao início do nome da propriedade para exibir os resultados na ordem crescente. Acrescente um símbolo - ao início do nome da propriedade para exibir os resultados em ordem decrescente. Se você não especificar uma ordem de classificação, o conjunto de resultados será exibido em ordem crescente por número inteiro de MessageIdentity.

Exemplo

Os exemplos a seguir mostram como consultar mensagens usando o comando Get-Message. O primeiro exemplo mostra como exibir todas as mensagens enfileiradas no servidor local que tenham sido recebidas de qualquer remetente no domínio especificado. O comando é comunicado por pipe ao comando Format-List para formatar os resultados como uma lista detalhada.

O segundo exemplo mostra como exibir todas as mensagens enfileiradas no servidor local que tenham sido recebidas de qualquer remetente no domínio especificado e que tenham um valor SCL maior que 3.

O terceiro exemplo mostra como estabelecer conexão com um servidor remoto e como exibir todas as mensagens enfileiradas no servidor remoto na ordem de classificação especificada. Os resultados são classificados primeiro em ordem crescente por endereço do remetente e, em seguida, em ordem decrescente de tamanho.

Para obter mais informações sobre pipeline, consulte Pipelining.

Para obter mais informações sobre como trabalhar com a saída de um comando, consulte Trabalhando com saída do comando.

Para obter mais informações sobre como usar o Shell de Gerenciamento do Exchange para executar tarefas do visualizador de filas, consulte Usando o Shell de Gerenciamento do Exchange para gerenciar filas.

Get-Message -Filter {FromAddress -like "*@contoso.com"} | format-list
Get-Message -Filter {FromAddress -like "*@contoso.com" -and SCL -gt 3}
Get-Message -Server exchange.contoso.com -SortOrder: +FromAddress,-Size