Mettre à jour une règle

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Modifiez les propriétés accessibles en écriture sur un objet messageRule et enregistrez les modifications.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) MailboxSettings.ReadWrite Non disponible.
Déléguée (compte Microsoft personnel) MailboxSettings.ReadWrite Non disponible.
Application MailboxSettings.ReadWrite Non disponible.

Requête HTTP

PATCH /me/mailFolders/inbox/messageRules/{id}
PATCH /users/{id | userPrincipalName}/mailFolders/inbox/messageRules/{id}

En-têtes de demande facultatifs

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas changé.

Propriété Type Description
actions messageRuleActions Actions à effectuer sur un message lorsque les conditions correspondantes sont remplies.
conditions messageRulePredicates Conditions qui, lorsqu’elles sont remplies, déclenchent les actions correspondantes pour cette règle.
displayName String Nom d’affichage de la règle.
exceptions messageRulePredicates Conditions d’exception pour la règle.
isEnabled Booléen Indique si la règle peut être appliquée aux messages.
isReadOnly Booléen Indique si la règle est accessible en lecture seule. Si oui, elle ne peut pas être modifiée ou supprimée par l’API REST de règles.
séquence Int32 Indique l’ordre dans lequel la règle est exécutée, parmi d’autres règles.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet messageRule mis à jour dans le corps de la réponse.

Exemple

Demande

L’exemple suivant modifie le nom de la règle et les actions à effectuer pour cette règle dans l’exemple de Get rule, du transfert vers une adresse au marquage de son importance comme élevée.

PATCH https://graph.microsoft.com/beta/me/mailFolders/inbox/messageRules/AQAAAJ5dZqA=
Content-type: application/json

{
    "displayName": "Important from partner",
    "actions": {
        "markImportance": "high"
     }
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#Me/mailFolders('inbox')/messageRules/$entity",
  "id":"AQAAAJ5dZqA=",
  "displayName":"Important from partner",
  "sequence":2,
  "isEnabled":true,
  "hasError":false,
  "isReadOnly":false,
  "conditions":{
    "senderContains":[
      "ADELE"
    ]
  },
  "actions":{
    "markImportance": "high"
  }
}