Remove-Message
Este cmdlet está disponível somente no Exchange local.
Use o cmdlet Remove-Message para excluir uma mensagem de uma fila em um servidor de Caixa de Correio ou em um servidor de Transporte de Borda.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Filter
Remove-Message
-Filter <String>
[-Server <ServerIdParameter>]
[-Confirm]
[-WhatIf]
[-WithNDR <Boolean>]
[<CommonParameters>]
Identity
Remove-Message
[-Identity] <MessageIdentity>
[-Confirm]
[-WhatIf]
[-WithNDR <Boolean>]
[<CommonParameters>]
Description
Uma mensagem transmitida a vários destinatários pode estar localizada em várias filas. Se você especificar um parâmetro Identity, a mensagem será removida de um única fila se essa identidade corresponder somente a uma única mensagem. Se a identidade corresponder a mais de uma mensagem, você receberá um erro. Para remover uma mensagem de mais de uma fila em uma única operação, use o parâmetro Filter. Se você tentar remover uma mensagem que estiver sendo entregue no momento, o status da mensagem será alterado para PendingDelete. A entrega da mensagem não será interrompida, mas se o envio da mensagem falhar e ela entrar novamente na fila, então ela será removida.
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. 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
Remove-Message -Server Server1 -Filter "FromAddress -eq 'Kweku@contoso.com'" -WithNDR $false
Este exemplo remove todas as mensagens que atendam aos seguintes critérios sem gerar notificações de falha na entrega:
- As mensagens são enviadas pelo remetente Kweku@contoso.com.
- As mensagens são enfileiradas no Servidor1.
Parâmetros
-Confirm
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
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, 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 confirmar 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 |
-Filter
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
O parâmetro Filter especifica uma ou mais mensagens através da sintaxe do filtro OPATH. O filtro OPATH inclui um nome de propriedade de mensagem seguido de um operador de comparação e um valor (por exemplo, "FromAddress -like '*@contoso.com'"
). Para obter detalhes sobre as propriedades de mensagens filtráveis e os operadores de comparação, veja Propriedades das mensagens nas filas e Localizar filas e mensagens em filas na Shell de Gestão do Exchange.
Pode especificar vários critérios com o operador e de comparação. 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: | True |
Valor do pipeline: | False |
Valor do pipeline pelo nome da propriedade: | False |
Valor dos argumentos restantes: | False |
-Identity
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
O parâmetro Identity especifica a mensagem. Uma entrada válida para este parâmetro utiliza 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.
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: | True |
Valor do pipeline: | True |
Valor do pipeline pelo nome da propriedade: | True |
Valor dos argumentos restantes: | False |
-Server
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
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 |
-WhatIf
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
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.
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 |
-WithNDR
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
Use o parâmetro WithNDR para especificar se uma notificação de falha na entrega é retornada ao remetente da mensagem. O valor padrão é $true. Esse parâmetro pode ser usado tanto com o parâmetro Identity e o conjunto de parâmetrosFilter.
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 |
CommonParameters
Este cmdlet suporta os 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.