getRuleListRequest

Returns the list of rules for a user.

Request

<getRuleListRequest/>

Response

<getRuleListResponse>
   <rules type="types:RuleList"/>
   <status type="types:Status"/>
</getRuleListResponse>

Elements

rules: Specifies the rules for a user's account.
code: Returns the error number related to the event. 0 indicates that the request was successful.
status: Returns the success or failure of the method.

Example

<getRuleListRequest/>

<getRuleListResponse> 
   <rules> 
      <rule type="Rule"> 
         <id>44630E88.domain1.po1.100.16E3837.1.B5E.1@10</id> 
         <name>Rule 1</name> 
         <version>12</version> 
         <modified>2012-09-13T19:17:22Z</modified> 
         <execution>New</execution> 
         <sequence>0</sequence> 
         <enabled>1</enabled> 
         <types>Appointment Mail Task</types> 
         <source>received sent</source> 
         <actions> 
            <action> 
               <type>Reply</type> 
               <item type="Mail"> 
                  <id>4506D010.domain1.po1.200.20000CB.1.1548.1@1</id> 
                  <version>1</version> 
                  <modified>2012-09-12T21:19:44Z</modified> 
                  <created>2012-09-12T21:19:42Z</created> 
                  <delivered>2012-09-12T21:19:42Z</delivered> 
                  <security>Normal</security> 
                  <subject>Test Subject</subject> 
                  <distribution> 
                     <sendoptions> 
                        <statusTracking>None</statusTracking> 
                     </sendoptions> 
                  </distribution> 
                  <options> 
                     <priority>Standard</priority> 
                  </options> 
                  <size>256</size> 
               </item> 
            </action> 
         </actions> 
      </rule> 
      <rule type="Rule"> 
         <id>4411628C.domain1.po1.100.16E3837.1.AA7.1@10</id> 
         <name>Vacation Rule</name> 
         <version>9</version> 
         <modified>2012-05-24T04:59:11Z</modified> 
         <execution>New</execution> 
         <sequence>-1</sequence> 
         <source>received</source> 
         <actions> 
            <action> 
               <type>Unknown</type> 
               <item type="Mail"> 
                  <id>441162AB.domain1.po1.200.20000CB.1.1228.1@1</id> 
                  <version>1</version> 
                  <modified>2012-03-10T18:27:39Z</modified> 
                  <created>2012-03-10T18:27:39Z</created> 
                  <delivered>2012-03-10T18:27:39Z</delivered> 
                  <security>Normal</security> 
                  <subject>Vacation Rule from u1</subject> 
                  <distribution> 
                     <from> 
                        <displayName>u1</displayName> 
                        <email>u1@phantom.com</email> 
                        <uuid>1DEB6970-175B-0000-890F-zz

                          6E00D5004E00</uuid> 
                      </from> 
                     <sendoptions> 
                        <statusTracking>None</statusTracking> 
                     </sendoptions> 
                  </distribution> 
                  <message> 
                     <part contentType="text/plain" length="8">
                            YXNkZg==</part> 
                  </message> 
                  <options> 
                     <priority>Standard</priority> 
                  </options> 
                  <size>272</size> 
               </item> 
            </action> 
         </actions> 
      </rule> 
   </rules> 
   <status> 
      <code>0</code> 
   </status> 
</getRuleListResponse>