2.2.4.5 t:RuleType Complex Type

The RuleType complex type represents a rule (2) in the user's mailbox.

 <xs:complexType name="RuleType">
   <xs:sequence>
     <xs:element name="RuleId"
       type="xs:string"
       minOccurs="0"
       maxOccurs="1"
      />
     <xs:element name="DisplayName"
       type="xs:string"
       maxOccurs="1"
       minOccurs="1"
      />
     <xs:element name="Priority"
       type="xs:int"
       minOccurs="1"
       maxOccurs="1"
      />
     <xs:element name="IsEnabled"
       type="xs:boolean"
       maxOccurs="1"
       minOccurs="1"
      />
     <xs:element name="IsNotSupported"
       type="xs:boolean"
       minOccurs="0"
       maxOccurs="1"
      />
     <xs:element name="IsInError"
       type="xs:boolean"
       minOccurs="0"
       maxOccurs="1"
      />
     <xs:element name="Conditions"
       type="t:RulePredicatesType"
       minOccurs="0"
       maxOccurs="1"
      />
     <xs:element name="Exceptions"
       type="t:RulePredicatesType"
       minOccurs="0"
       maxOccurs="1"
      />
     <xs:element name="Actions"
       type="t:RuleActionsType"
       minOccurs="0"
       maxOccurs="1"
      />
   </xs:sequence>
 </xs:complexType>
  

The following table lists the child elements of the RuleType complex type.

Element

Type

Description

RuleId

xs:string ([XMLSCHEMA2])

The rule (2) identifier.

DisplayName

xs:string

A value that contains the display name of a rule (2).

Priority

xs:int ([XMLSCHEMA2])

A value that indicates the order in which a rule (2) is to be run.

IsEnabled

xs:boolean ([XMLSCHEMA2])

Indicates whether the rule (2) is enabled.

IsNotSupported

xs:boolean

Indicates whether the rule (2) cannot be modified with the managed code APIs.

IsInError

xs:boolean

Indicates whether the rule (2) is in an error condition.

Conditions

t:RulePredicatesType (section 2.2.4.4)

The conditions that, when fulfilled, will trigger the rule (2) actions for that rule (2).

Exceptions

t:RulePredicatesType (section 2.2.4.4)

The exceptions that represent all the available rule (2) exception conditions for the inbox rule (2).

Actions

t:RuleActionsType (section 2.2.4.1)

The actions to be taken on a message when the conditions are fulfilled.

This complex type contains all required fields to represent an Inbox rule (2).

The RuleType complex type can be extended to represent other rule (2) types.

The CreateRuleOperationType complex type, as specified in section 3.1.4.2.3.5, does not include a RuleId element in the RuleType complex type. The rule ID will be generated when the rule (2) is successfully created in the server message store.

Show: