Compartilhar via


Get-InboxRule

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.

Use o cmdlet Get-InboxRule para exibir as propriedades da regra da caixa de entrada. As regras de Caixa de Entrada são usadas para processar mensagens na Caixa de Entrada com base nas condições especificadas e realizar ações, como mover uma mensagem para uma pasta especificada ou excluir uma mensagem.

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

Syntax

Get-InboxRule
   [[-Identity] <InboxRuleIdParameter>]
   [-BypassScopeCheck]
   [-DescriptionTimeFormat <String>]
   [-DescriptionTimeZone <ExTimeZoneValue>]
   [-DomainController <Fqdn>]
   [-IncludeHidden]
   [-Mailbox <MailboxIdParameter>]
   [-SweepRules]
   [<CommonParameters>]

Description

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.

Observação: este cmdlet não funciona para membros do View-Only grupo de funções de Gerenciamento de Organização em Exchange Online ou a função Leitor Global no Azure Active Directory.

Exemplos

Exemplo 1

Get-InboxRule -Mailbox Joe@Contoso.com

Este exemplo recupera todas as regras de caixa de entrada para a caixa de correio Joe@Contoso.com.

Exemplo 2

Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "mm/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time"

Este exemplo recupera a regra de caixa de entrada ReceivedLastYear da caixa de correio joe@contoso.com na qual o parâmetro ReceivedBeforeDate foi definido quando a regra foi criada. Os parâmetros DescriptionTimeFormat e DescriptionTimeZone são usados neste exemplo para especificar a formatação do tempo e do fuso horário usado na propriedade Description da regra.

Parâmetros

-BypassScopeCheck

A opção BypassScopeCheck especifica se deve ignorar a verificação de escopo do usuário que está executando o comando. Não é preciso especificar um valor com essa opção.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online

-DescriptionTimeFormat

O parâmetro DescriptionTimeFormat especifica o formato para valores de tempo na descrição da regra. Por exemplo:

mm/dd/yyyy, onde mm é o mês de 2 dígitos, dd é o dia de 2 dígitos e yyyy é o ano de 4 dígitos.

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, Exchange Online

-DescriptionTimeZone

O parâmetro DescriptionTimeZone especifica o fuso horário usado para valores de tempo na descrição da regra.

$false: a regra ou política está desabilitada.

Para ver os valores disponíveis, execute o seguinte comando: $TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display.

Se o valor contiver espaços, coloque-o entre aspas ("). O valor padrão é a configuração de fuso horário do servidor exchange.

Type:ExTimeZoneValue
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, Exchange Online

-DomainController

Este parâmetro está disponível somente no Exchange local.

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.

Type:Fqdn
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 regra caixa de entrada que você deseja exibir. É possível usar qualquer valor que identifique a regra com exclusividade. Por exemplo:

  • Nome
  • Propriedade RuleIdentity (por exemplo, 16752869479666417665).
  • Exchange Online: MailboxAlias\RuleIdentity (por exemplo, rzaher\16752869479666417665).
  • Exchange local: MailboxCanonicalName\RuleIdentity (por exemplo, contoso.com/Users/Rick Zaher\16752869479666417665).
Type:InboxRuleIdParameter
Position:1
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, Exchange Online

-IncludeHidden

A opção IncludeHidden especifica se deve incluir regras ocultas da caixa de entrada nos resultados. Não é preciso especificar um valor com essa opção.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Mailbox

O parâmetro Mailbox especifica a caixa de correio que contém a regra da Caixa de Entrada. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • Domain\username
  • Endereço de email
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ID de usuário ou nome UPN
Type:MailboxIdParameter
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, Exchange Online

-SweepRules

Este parâmetro está disponível somente no Exchange local.

A opção SweepRules especifica se deve retornar apenas regras de varredura nos resultados. Não é preciso especificar um valor com essa opção.

As regras de varredura são executadas em intervalos regulares para ajudar a manter sua caixa de entrada limpa.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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.