New-SweepRule

Módulo:
Exchange PowerShell

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 ambiente ou de outro.

Use o cmdlet New-SweepRule para criar regras de varredura em caixas de correio. As regras de varredura são executadas em intervalos regulares para ajudar a manter sua caixa de entrada limpa.

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

Sintaxe

Default (Default) 

New-SweepRule
    [-Name] <String>
    -Provider <String>
    [-Confirm]
    [-DestinationFolder <MailboxFolderIdParameter>]
    [-DomainController <Fqdn>]
    [-Enabled <Boolean>]
    [-ExceptIfFlagged <Boolean>]
    [-ExceptIfPinned <Boolean>]
    [-KeepForDays <Int32>]
    [-KeepLatest <Int32>]
    [-Mailbox <MailboxIdParameter>]
    [-Sender <RecipientIdParameter>]
    [-SourceFolder <MailboxFolderIdParameter>]
    [-SystemCategory <SystemCategoryType>]
    [-WhatIf]
    [<CommonParameters>]

Description

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

New-SweepRule -Name "From Michelle" -Mailbox "Felipe Apodaca" -Provider Exchange16 -Sender michelle@fabrikam.com -KeepLatest 1

Este exemplo cria uma nova regra de varredura denominada "De Michelle" na caixa de correio de Felipe Apodaca que mantém a mensagem mais recente na pasta Caixa de michelle@fabrikam.com Entrada e move as mensagens mais antigas para a pasta Itens Excluídos.

Exemplo 2

New-SweepRule -Name "From Lila" -Mailbox "Felipe Apodaca" -Provider Exchange16 -Sender lila@fabrikam.com -KeepForDays 10

Este exemplo cria uma nova regra de varredura chamada "De Lila" na caixa de correio de Felipe Apodaca que move mensagens da pasta Caixa de Entrada com mais de lila@fabrikam.com 10 dias para a pasta Itens Excluídos.

Exemplo 3

New-SweepRule -Name "From Jeff" -Mailbox "Felipe Apodaca" -Provider Exchange16 -Sender jeffm@fabrikam.com -SourceFolder "Felipe:\Sent Items" -KeepForDays 10

Este exemplo cria uma nova regra de varredura chamada "De Jeff" na caixa de correio de Felipe Apodaca que move mensagens da pasta Itens Enviados com mais de jeffm@fabrikam.com 10 dias para a pasta Itens Excluídos.

Parâmetros

-Confirm

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer 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 reconhecer 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

-DestinationFolder

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro DestinationFolder especifica uma ação para a regra Sweep que move mensagens para a pasta especificada. A sintaxe é MailboxID:\ParentFolder[\SubFolder].

Para o valor de , você pode usar qualquer valor que identifique exclusivamente a caixa de MailboxIDcorreio. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • Domínio\Nome de usuário
  • Endereço de email
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ID de usuário ou nome UPN

Os valores de exemplo para este parâmetro são john@contoso.com:\Unimportant ou John:\Inbox\Misc. O valor padrão é MailboxID:\Deleted Items.

Propriedades do parâmetro

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

-DomainController

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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.

Propriedades do parâmetro

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

-Enabled

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Enabled especifica se a regra Sweep está habilitada ou desabilitada. Os valores válidos são:

  • $true: A regra está habilitada. Esse valor é o padrão.
  • $false: A regra está desabilitada.

Depois de criar a regra, você pode habilitá-la ou desabilitá-la usando os cmdlets Enable-SweepRule e Disable-SweepRule.

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

-ExceptIfFlagged

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

O parâmetro ExceptIfFlagged especifica uma exceção para a regra Sweep que procura mensagens com um sinalizador de mensagem aplicado. Os valores válidos são:

  • $true: a ação de regra não é aplicada a mensagens que têm um sinalizador de mensagem aplicado.
  • $false: a exceção não é usada.

Os valores típicos de sinalizador de mensagem são:

  • Qualquer
  • Chamada
  • DoNotForward
  • Acompanhamento
  • Para sua informação
  • Encaminhar
  • NoResponseNecessary
  • Leitura
  • Responder
  • Responder a todos
  • Revisão

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

-ExceptIfPinned

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

O parâmetro PinMessage especifica uma exceção para a regra Sweep que procura mensagens fixadas. Os valores válidos são:

  • $true: A ação da regra não é aplicada a mensagens fixadas na parte superior da Caixa de Entrada.
  • $false: a exceção não é usada.

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

-KeepForDays

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro KeepForDays especifica uma ação para a regra Sweep que especifica o número de dias para manter mensagens que correspondam às condições da regra. Após o número de dias, as mensagens são movidas para o local especificado pelo parâmetro DestinationFolder (por padrão, a pasta Itens Excluídos).

Não é possível usar esse parâmetro com o parâmetro KeepLatest e a regra de varredura deve conter um valor de parâmetro KeepForDays ou KeepLatest .

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

-KeepLatest

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro KeepLatest especifica uma ação para a regra Sweep que especifica o número de mensagens a serem mantidas que correspondem às condições da regra. Depois que o número de mensagens é excedido, as mensagens mais antigas são movidas para o local especificado pelo parâmetro DestinationFolder (por padrão, a pasta Itens Excluídos).

Não é possível usar esse parâmetro com o parâmetro KeepForDays e a regra de varredura deve conter um valor de parâmetro KeepForDays ou KeepLast.

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

-Mailbox

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Mailbox especifica a caixa de correio em que você deseja criar a regra Sweep. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • Domínio\Nome de usuário
  • Endereço de email
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ID de usuário ou nome UPN

Propriedades do parâmetro

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

-Name

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Name especifica o nome da regra Sweep. Se o valor contiver espaços, coloque-o entre aspas.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Provider

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Provider especifica o provedor para a regra Sweep. Se o valor contiver espaços, coloque-o entre aspas.

Para regras de varredura criadas no Outlook na Web, o valor padrão é Exchange16.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Sender

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Sender especifica uma condição para a regra Sweep que procura o remetente especificado nas mensagens. Para remetentes internos, é possível usar qualquer valor que identifique exclusivamente o remetente. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • DN canônico
  • GUID

Para remetentes externos, use o endereço de email.

Propriedades do parâmetro

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

-SourceFolder

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro SourceFolder especifica uma condição para a regra Sweep que procura mensagens na pasta especificada. A sintaxe é MailboxID:\ParentFolder[\SubFolder].

Para o valor de , você pode usar qualquer valor que identifique exclusivamente a caixa de MailboxIDcorreio. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • Domínio\Nome de usuário
  • Endereço de email
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ID de usuário ou nome UPN

Os valores de exemplo para este parâmetro são john@contoso.com:\Marketing ou John:\Inbox\Reports. O valor padrão é MailboxID:\Inbox.

Propriedades do parâmetro

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

-SystemCategory

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro SystemCategory especifica uma condição para a regra de varredura que procura mensagens com a categoria de sistema especificada. As categorias do sistema estão disponíveis para todas as caixas de correio da organização. Os valores válidos são:

  • NotDefined
  • Contas
  • Documento
  • DocumentPlus
  • Evento
  • Família
  • Arquivo
  • Versão de pré-lançamento
  • Do Contato
  • Importante
  • LiveView
  • Hospedagem
  • Lista de Discussão
  • Boletim Informativo
  • Photo
  • Comprar
  • RentalCar
  • Reserva de Restaurante
  • RetiredPromotion
  • Notificação de envio
  • Compras
  • Atualização Social
  • Viagem
  • Vídeo

Propriedades do parâmetro

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

-WhatIf

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. 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

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.