complexType "ruleType"
Namespace:
Content:
complex, 4 attributes, 8 elements, elem. wildcard
Defined:
globally in myInbox.xsd; see XML source
Includes:
definitions of 1 attribute, 8 elements, elem. wildcard
Used:
XML Representation Summary
<...
   
 = 
xsd:nonNegativeInteger
 = 
xsd:hexBinary
 = 
xsd:string
 = 
xsd:unsignedLong
   
>
   
Content: 
</...>
Content Model Elements (8):
action (in rule), condition (in rule), name (type hs:localizableString), provider (in rule), runat (in rule), runwhen (in rule), state (in rule), type (in rule)
All Direct / Indirect Based Elements (1):
rule (in myInbox)
Known Usage Locations
Annotation
Rules specify actions that should be performed on the active message during sending or delivery.
XML Source (see within schema source)
<xsd:complexType name="ruleType">
<xsd:annotation>
<xsd:documentation>
Rules specify actions that should be performed on the active message during sending or delivery.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="name" type="hs:localizableString">
<xsd:annotation>
<xsd:documentation>
The application-defined, human readable identifier of the rule.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="state" type="ruleStateType">
<xsd:annotation>
<xsd:documentation>
Indicates whether the rule is currently enabled.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="runat" type="runatType">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes where the rule must run. The only allowable value
to date is 'server'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="runwhen" type="runwhenType">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes when the rule must run. The only allowable values
are 'sending' and 'receiving'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="type" type="ruleTypeType">
<xsd:annotation>
<xsd:documentation>
Specifies if this is of type 'oof' or 'normal'
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="provider" type="hs:localizableString">
<xsd:annotation>
<xsd:documentation>
The application-defined provider of the rule. This is provided so that multiple applicaions
can (if they so desire) only alter their own rules.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="condition">
<xsd:annotation>
<xsd:documentation>
This element's select attribute specifies the xpath expression used to evaluate if the this
rule applies to the active message.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<!-- empty content -->
<xsd:attribute name="select" type="hs:selectType" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies an xpath expression used to determine if this rule applies
to the active message. Because rules only apply to messages, this statement must
be scoped to the message element:

Legal examples:
"./importance = 'high'"
"./from/email = 'someone@microsoft.com' and contains(./subject/full, 'hello')"

Illegal examples:
"/myInbox/message[./importance = 'high']"
"/myInbox/folder"
"/myInbox/rule"
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="unbounded" name="action">
<xsd:annotation>
<xsd:documentation>
Specifies an individual action to perform if the select element
matches minOccurs-maxOccurs messages.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="copyMessage" type="copyMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="moveMessage" type="moveMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="deleteMessage" type="deleteMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="assignCategory" type="assignCategoryActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="forwardMessage" type="forwardMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="forwardAsAttachment" type="forwardAsAttachmentActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="serverReply" type="serverReplyActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="redirectMessage" type="redirectMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="flagMessage" type="flagMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="markAsRead" type="markAsReadActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="stopProcessingRulesOfThisType" type="stopProcessingRulesOfThisTypeType"/>
</xsd:sequence>
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="required">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes the order that this action should be performed
in relative to all other actions for this rule.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="required">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes the order that this action should be performed
in relative to all other actions for this rule.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attributeGroup ref="hs:standardBlueAttributeGroup"/>
</xsd:complexType>
Attribute Detail (all declarations; 4/4)
changeNumber
Type:
Use:
required
Defined:
XML Source (see within schema source)
<xsd:attribute name="changeNumber" type="changeNumberType" use="required"/>

creator
Type:
Use:
required
Defined:
XML Source (see within schema source)
<xsd:attribute name="creator" type="creatorType" use="required"/>

id
Type:
Use:
required
Defined:
XML Source (see within schema source)
<xsd:attribute name="id" type="idType" use="required"/>

sequence
Type:
xsd:unsignedLong, predefined
Use:
required
Defined:
locally within (this) ruleType complexType
This required attribute specifes the order that this action should be performed in relative to all other actions for this rule.
XML Source (see within schema source)
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="required">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes the order that this action should be performed
in relative to all other actions for this rule.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
Content Element Detail (all declarations; 9/9)
action
Type:
anonymous complexType, complex content
Defined:
locally within (this) ruleType complexType
Specifies an individual action to perform if the select element matches minOccurs-maxOccurs messages.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" name="action">
<xsd:annotation>
<xsd:documentation>
Specifies an individual action to perform if the select element
matches minOccurs-maxOccurs messages.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="copyMessage" type="copyMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="moveMessage" type="moveMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="deleteMessage" type="deleteMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="assignCategory" type="assignCategoryActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="forwardMessage" type="forwardMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="forwardAsAttachment" type="forwardAsAttachmentActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="serverReply" type="serverReplyActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="redirectMessage" type="redirectMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="flagMessage" type="flagMessageActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="markAsRead" type="markAsReadActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="stopProcessingRulesOfThisType" type="stopProcessingRulesOfThisTypeType"/>
</xsd:sequence>
<xsd:attribute name="sequence" type="xsd:unsignedLong" use="required">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes the order that this action should be performed
in relative to all other actions for this rule.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>

condition
Type:
anonymous complexType, empty content
Defined:
locally within (this) ruleType complexType
This element's select attribute specifies the xpath expression used to evaluate if the this rule applies to the active message.
XML Source (see within schema source)
<xsd:element name="condition">
<xsd:annotation>
<xsd:documentation>
This element's select attribute specifies the xpath expression used to evaluate if the this
rule applies to the active message.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<!-- empty content -->
<xsd:attribute name="select" type="hs:selectType" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies an xpath expression used to determine if this rule applies
to the active message. Because rules only apply to messages, this statement must
be scoped to the message element:

Legal examples:
"./importance = 'high'"
"./from/email = 'someone@microsoft.com' and contains(./subject/full, 'hello')"

Illegal examples:
"/myInbox/message[./importance = 'high']"
"/myInbox/folder"
"/myInbox/rule"
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>

name
Type:
hs:localizableString, simple content
Defined:
locally within (this) ruleType complexType
The application-defined, human readable identifier of the rule.
XML Source (see within schema source)
<xsd:element name="name" type="hs:localizableString">
<xsd:annotation>
<xsd:documentation>
The application-defined, human readable identifier of the rule.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

provider
Type:
hs:localizableString, simple content
Defined:
locally within (this) ruleType complexType
The application-defined provider of the rule. This is provided so that multiple applicaions can (if they so desire) only alter their own rules.
XML Source (see within schema source)
<xsd:element name="provider" type="hs:localizableString">
<xsd:annotation>
<xsd:documentation>
The application-defined provider of the rule. This is provided so that multiple applicaions
can (if they so desire) only alter their own rules.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

runat
Type:
runatType, simple content
Defined:
locally within (this) ruleType complexType
This required attribute specifes where the rule must run. The only allowable value to date is 'server'.
XML Source (see within schema source)
<xsd:element name="runat" type="runatType">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes where the rule must run. The only allowable value
to date is 'server'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

runwhen
Type:
runwhenType, simple content
Defined:
locally within (this) ruleType complexType
This required attribute specifes when the rule must run. The only allowable values are 'sending' and 'receiving'.
XML Source (see within schema source)
<xsd:element name="runwhen" type="runwhenType">
<xsd:annotation>
<xsd:documentation>
This required attribute specifes when the rule must run. The only allowable values
are 'sending' and 'receiving'.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

state
Type:
ruleStateType, simple content
Defined:
locally within (this) ruleType complexType
Indicates whether the rule is currently enabled.
XML Source (see within schema source)
<xsd:element name="state" type="ruleStateType">
<xsd:annotation>
<xsd:documentation>
Indicates whether the rule is currently enabled.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

type
Type:
ruleTypeType, simple content
Defined:
locally within (this) ruleType complexType
Specifies if this is of type 'oof' or 'normal'
XML Source (see within schema source)
<xsd:element name="type" type="ruleTypeType">
<xsd:annotation>
<xsd:documentation>
Specifies if this is of type 'oof' or 'normal'
</xsd:documentation>
</xsd:annotation>
</xsd:element>

{any element with non-schema namespace}
Defined:
within (this) ruleType complexType
XML Source (see within schema source)
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>