次の方法で共有


ルールを作成する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

条件とアクションのセットを指定して messageRule オブジェクトを作成します。

Outlook では、ユーザーの受信トレイで受信したメッセージが指定した条件を満たしている場合に、それらのアクションが実行されます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) MailboxSettings.ReadWrite 注意事項なし。
委任 (個人用 Microsoft アカウント) MailboxSettings.ReadWrite 注意事項なし。
アプリケーション MailboxSettings.ReadWrite 注意事項なし。

HTTP 要求

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。

要求本文

要求本文に、ルールを適用するパラメーターを指定します。 ルールを作成する際に本文に通常指定するパラメーターは、次のとおりです。 必要に応じて、本文に他の書き込み可能な messageRule プロパティを指定することもできます。

パラメーター 説明
actions messageRuleActions 対応する条件 (存在する場合) が満たされたときにメッセージに対して実行されるアクション。 必須です。
conditions messageRulePredicates 該当するルール アクションをトリガーするために満たす必要のある条件。 省略可能です。
displayName String ルールの表示名。 必須です。
exceptions messageRulePredicates ルールの例外条件を表します。 オプション。
isEnabled Boolean メッセージに対するルールの適用が有効になっているかどうかを示します。 オプション。
sequence Int32 他のルールもある中で、そのルールが実行される順序を示します。 必須です。

応答

成功した場合、このメソッドは 201 Created 応答コードと、応答本文に messageRule オブジェクトを返します。

要求

次の例は要求を示しています。

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
     }
}

応答

次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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"
          }
        }
      ]
  }
}