ルールを作成するCreate rule

条件とアクションのセットを指定して messageRule オブジェクトを作成します。Create a messageRule object by specifying a set of conditions and actions.

Outlook では、ユーザーの受信トレイで受信したメッセージが指定した条件を満たしている場合に、それらのアクションが実行されます。Outlook carries out those actions if an incoming message in the user's Inbox meets the specified conditions.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) MailboxSettings.ReadWriteMailboxSettings.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) MailboxSettings.ReadWriteMailboxSettings.ReadWrite
アプリケーションApplication MailboxSettings.ReadWriteMailboxSettings.ReadWrite

HTTP 要求HTTP request

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

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

要求本文に、ルールを適用するパラメーターを指定します。In the request body, supply the parameters that are applicable to your rule. ルールを作成する際に本文に通常指定するパラメーターは、次のとおりです。The following are body parameters that are typically used when creating rules. 必要に応じて、本文に他の書き込み可能な messageRule プロパティを指定することもできます。You can specify any other writable messageRule properties as appropriate in the request body.

名前Name Type 説明Description
actionsactions messageRuleActionsmessageRuleActions 該当する条件があり、それが満たされる場合にメッセージに対して実行されるアクションです。必須。Actions to be taken on a message when the corresponding conditions, if any, are fulfilled. Required.
conditionsconditions messageRulePredicatesmessageRulePredicates 満たされた場合に、そのルールに該当するアクションをトリガーする条件です。省略可能。Conditions that when fulfilled, will trigger the corresponding actions for that rule. Optional.
displayNamedisplayName StringString ルールの表示名。必須。The display name of the rule. Required.
exceptionsexceptions messageRulePredicatesmessageRulePredicates ルールの例外条件を表します。省略可能。Represents exception conditions for the rule. Optional.
isEnabledisEnabled BooleanBoolean メッセージに対するルールの適用が有効になっているかどうかを示します。省略可能。Indicates whether the rule is enabled to be applied to messages. Optional.
sequencesequence Int32Int32 他のルールもある中で、そのルールが実行される順序を示します。必須。Indicates the order in which the rule is executed, among other rules. Required.

応答Response

成功した場合、このメソッドは 201 Created 応答コードと、応答本文に messageRule オブジェクトを返します。If successful, this method returns 201 Created response code and a messageRule object in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

POST https://graph.microsoft.com/v1.0/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.onmicrosoft.com"
              }
           }
        ],
        "stopProcessingRules": true
     }    
}

応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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.onmicrosoft.com"
          }
        }
      ]
  }
}