messageRule リソースの種類messageRule resource type

ユーザーの受信トレイ内のメッセージに適用されるルールです。A rule that applies to messages in the Inbox of a user.

Outlook では、受信トレイ内の受信メッセージに対し、一定の条件に基づいて特定の操作を実行するルールを設定できます。In Outlook, you can set up rules for incoming messages in the Inbox to carry out specific actions upon certain conditions.

プログラムでこれらのルールにアクセスするには、受信トレイの フォルダーmessageRules ナビゲーション プロパティを使用します。Programmatically, you can access rules through the messageRules navigation property of the Inbox folder. 各ルールは messageRule リソース、利用可能なルールの処理は messageRuleActions 複合型、利用可能なルール条件および例外は messageRulePredicates 複合型で表されます。Each rule is represented by this messageRule resource, available rule actions are represented by the messageRuleActions complex type, and available rule conditions and exceptions are represented by the messageRulePredicates complex type.

プロパティProperties

プロパティProperty Type 説明Description
actionsactions messageRuleActionsmessageRuleActions 該当する条件が満たされた場合にメッセージに対して実行されるアクション。Actions to be taken on a message when the corresponding conditions are fulfilled.
conditionsconditions messageRulePredicatesmessageRulePredicates 該当するルール アクションをトリガーするために満たす必要のある条件。Conditions that when fulfilled, will trigger the corresponding actions for that rule.
displayNamedisplayName StringString ルールの表示名。The display name of the rule.
exceptionsexceptions messageRulePredicatesmessageRulePredicates ルールの例外条件。Exception conditions for the rule.
hasErrorhasError BooleanBoolean ルールがエラー状態かどうかを示します。Indicates whether the rule is in an error condition. 読み取り専用です。Read-only.
idid StringString ルールの一意識別子。The unique identifier of the rule. 読み取り専用。Read-only.
isEnabledisEnabled BooleanBoolean メッセージに対するルールの適用が有効になっているかどうかを示します。Indicates whether the rule is enabled to be applied to messages.
isReadOnlyisReadOnly BooleanBoolean ルールが読み取り専用のため、ルールの REST API による変更や削除ができないことを示します。Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
sequencesequence Int32Int32 他のルールもある中で、そのルールが実行される順序を示します。Indicates the order in which the rule is executed, among other rules.

JSON 表記JSON representation

以下は、リソースの JSON 表記です。Here is a JSON representation of the resource.

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

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
ルールの一覧表示List rules messageRule コレクションmessageRule collection ユーザーの受信トレイに定義されているすべての messageRule オブジェクトを取得します。Get all the messageRule objects defined for the user's Inbox.
ルールの取得Get rule messageRulemessageRule messageRule オブジェクトのプロパティとリレーションシップを読み取ります。Read the properties and relationships of a messageRule object.
作成Create messageRulemessageRule 条件とアクションのセットを指定して messageRule オブジェクトを作成します。Create a messageRule object by specifying a set of conditions and actions.
更新Update messageRulemessageRule messageRule オブジェクトの書き込み可能なプロパティを変更し、変更を保存します。Change writable properties on a messageRule object and save the changes.
削除Delete なしNone 指定した messageRule オブジェクトを削除します。Delete the specified messageRule object.