Partager via


Créer 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 .

Créez un objet messageRule en spécifiant un ensemble de conditions et d’actions.

Outlook effectue ces actions si un message entrant dans la boîte de réception de l’utilisateur remplit les conditions spécifiées.

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

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

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
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

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

En-têtes de demande

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

Corps de la demande

Dans le corps de la demande, indiquez les paramètres qui s’appliquent à votre règle. Vous trouverez ci-dessous les paramètres de corps qui sont généralement utilisés lors de la création de règles. Vous pouvez spécifier d’autres propriétés messageRule accessibles en écriture selon vos besoins dans le corps de la demande.

Paramètre Type Description
actions messageRuleActions Actions à effectuer sur un message lorsque les conditions correspondantes, le cas échéant, sont remplies. Obligatoire.
conditions messageRulePredicates Conditions qui, lorsqu’elles sont remplies, déclenchent les actions correspondantes pour cette règle. Facultatif.
displayName String Nom d’affichage de la règle. Obligatoire.
exceptions messageRulePredicates Représente les conditions d’exception de la règle. Facultatif.
isEnabled Booléen Indique si la règle peut être appliquée aux messages. Facultatif.
séquence Int32 Indique l’ordre dans lequel la règle est exécutée, parmi d’autres règles. Obligatoire.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 201 Created et un objet messageRule dans le corps de la réponse.

Exemple

Demande

L’exemple suivant illustre une demande.

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

{
    "displayName": "From partner",
    "sequence": 2,
    "isEnabled": true,
    "conditions": {
        "senderContains": [
          "adele"
        ]
     },
     "actions": {
        "forwardTo": [
          {
             "emailAddress": {
                "name": "Alex Wilbur",
                "address": "AlexW@contoso.com"
              }
           }
        ],
        "stopProcessingRules": true
     }
}

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 201 Created
Content-type: application/json

{
  "id":"AQAAAJ5dZqA=",
  "displayName":"From partner",
  "sequence":2,
  "isEnabled":true,
  "hasError":false,
  "isReadOnly":false,
  "conditions":{
    "senderContains":[
      "ADELE"
    ]
  },
  "actions":{
      "stopProcessingRules":true,
      "forwardTo":[
        {
          "emailAddress":{
            "name":"Alex Wilbur",
            "address":"AlexW@contoso.com"
          }
        }
      ]
  }
}