Share via

4.4 GetInboxRules

  • Article

The following is an example of a GetInboxRules operation.

The client constructs the request XML and sends it to the server. The request identifies the user in the MailboxSmtpAddress element. All Inbox rules (2) for the identified user are to be returned in the response.

 <?xml version="1.0" encoding="utf-8"?>
 <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
         xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
         xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header>
     <t:RequestServerVersion Version="Exchange2010_SP1" />
   </soap:Header>
   <soap:Body>
     <m:GetInboxRules>
       <m:MailboxSmtpAddress>User1@Contoso.com</m:MailboxSmtpAddress>
     </m:GetInboxRules>
   </soap:Body>
 </soap:Envelope>

The server constructs the response XML and sends it to the client. The FolderId attribute has been shortened to preserve readability. In this example, there is one rule (2) in the returned InboxRules collection.

 <?xml version="1.0" encoding="utf-8"?>
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <h:ServerVersionInfo MajorVersion="14"
         MinorVersion="1" MajorBuildNumber="139"
         MinorBuildNumber="0"
         Version="Exchange2010_SP1"
         xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
         xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <GetInboxRulesResponse ResponseClass="Success"
         xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
       <ResponseCode>NoError</ResponseCode>
       <OutlookRuleBlobExists>true</OutlookRuleBlobExists>
       <InboxRules>
         <Rule xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
           <RuleId>dCsAAABjzvA=</RuleId>
           <DisplayName>MoveInterestingToJunk</DisplayName>
           <Priority>1</Priority>
           <IsEnabled>true</IsEnabled>
           <Conditions>
             <ContainsSubjectStrings>
               <String>Interesting</String>
             </ContainsSubjectStrings>
           </Conditions>
           <Actions>
             <MoveToFolder>
               <FolderId ChangeKey="AQAAAA==" Id="AAMkAGYzZjZm" />
             </MoveToFolder>
           </Actions>
         </Rule>
       </InboxRules>
     </GetInboxRulesResponse>
   </s:Body>
 </s:Envelope>