Tipo de recurso messageRule

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Uma regra que se aplica a mensagens na Caixa de Entrada de um usuário.

No Outlook, é possível configurar regras para mensagens recebidas na Caixa de Entrada, para realizar ações específicas em determinadas condições.

Programaticamente, você pode acessar regras por meio da propriedade de navegação messageRules da pasta Caixa de Entrada. Cada regra é representada por esse recurso messageRule, as ações de regra disponíveis são representadas pelo tipo complexo messageRuleActions e as condições e exceções de regra disponíveis são representadas pelo tipo complexo messageRulePredicates.

Methods

Método	Tipo de retorno	Descrição
Listar regras	Coleção messageRule	Obtenha todos os objetos messageRule definidos para a Caixa de Entrada do usuário.
Obter regra	messageRule	Leia as propriedades e as relações de um objeto messageRule.
Criar	messageRule	Crie um objeto messageRule especificando um conjunto de condições e ações.
Atualizar	messageRule	Altere as propriedades graváveis em um objeto messageRule e salve as alterações.
Delete	Nenhum	Exclua o objeto messageRule especificado.

Propriedades

Propriedade	Tipo	Descrição
actions	messageRuleActions	Ações a serem realizadas em uma mensagem quando as condições correspondentes forem atendidas.
conditions	messageRulePredicates	Condições que, quando atendidas, acionarão as ações correspondentes dessa regra.
displayName	Cadeia de caracteres	O nome de exibição da regra.
exceptions	messageRulePredicates	Condições de exceção para a regra.
hasError	Boolean	Indica se a regra está em uma condição de erro. Somente leitura.
id	Cadeia de caracteres	O identificador exclusivo da regra. Somente leitura.
isEnabled	Booliano	Indica se a regra está habilitada para ser aplicada a mensagens.
isReadOnly	Boolean	Indica se a regra é somente leitura e não pode ser modificada ou excluída pelas regras da API REST.
sequence	Int32	Indica a ordem em que a regra é executada, entre outras regras.

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "actions": {"@odata.type": "microsoft.graph.messageRuleActions"},
  "conditions": {"@odata.type": "microsoft.graph.messageRulePredicates"},
  "displayName": "String",
  "exceptions": {"@odata.type": "microsoft.graph.messageRulePredicates"},
  "hasError": "Boolean",
  "id": "String",
  "isEnabled": "Boolean",
  "isReadOnly": "Boolean",
  "sequence": "Int32"
}