getQuickMessagesRequest

Provides quicker access to new or modified item or to all of the items than the standard getItems methods. Before implementing getQuickMessagesRequest, consider using GroupWise Events instead. GroupWise Events is superior and is the recommended way to learn about changes to a GroupWise user’s mailbox.

Request

<getQuickMessagesRequest>
   <list type="types:MessageList"/>
   <ref="types:startDate"/>
   <container type="types:uid"/>
   <types type="string"/>
   <source type="string"/>
   <view type="string"/>
   <count type="int"/>
</getQuickMessagesRequest>

Response

<getQuickMessagesResponse>
   <startDate/>
   <items type="types:Items"/>
   <status type="types:Status"/>
</getQuickMessagesResponse>

Elements

list

Specifies what items to query:

new	Provides the fastest access to new items. The new list supports a view that can return the whole item. The larger the view, the slower this approach becomes.
modified	Provides slower access to modified items.
all	Provides the slowest access to all items.

startDate

Returns items that are newer or equal to the startDate.

container

Specifies the container to query. If a container is not provided, the query is across all folders

types

Specifies the message types to return. If message type is not provided, it returns all message types. If the container is the calendar and the message type is not provided, calendarItems are returned. Calendar Items are appointments, notes, and tasks.

source

Specifies the source of the items. If the source is not provided, draft, personal, and received items are returned.

view

Specifies the fields to be returned. If the view is not included and the list is not equal to new, all the indexed fields are returned. If the list is new, you can specify a view to return the entire item.

count

Specifies the number of items to return. If no count is given, all items are returned.

startDate

Specifies the time value just before the last query. You can then pass in startDate to getQuickMessages subsequently, which ensures that the client is always working with the server time when queries are performed. It also mitigates the time difference between the client and server.

items

Returns the items that match the query.

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.

Remarks

getQuickMessagesRequest provides quicker access because it accesses only those fields that are stored in the GroupWise database indexes. Some fields that are stored in the indexes and returned are categories, container, id, message type, modified, originalSubject, sendOptions, source, startDate, status, and subject.

getQuickMessagesRequest has the following limitations:

Is not supported in proxy mode.
Cannot be used on contact, query, and trash folders.
Does not return a response when items are deleting.

Example

<getQuickMessagesRequest> 
   <list>New</list> 
   <container>6.domain1.po1.100.0.1.0.1@15</container> 
   <view>default recipients message</view> 
</getQuickMessagesRequest>

<getQuickMessagesResponse> 
   <startDate>2012-09-13T19:10:52Z</startDate> 
   <items> 
      <item type="Mail"> 
         <id>44EDB77E.domain1.po1.100.16E3837.1.F7A.1@1:6.
            domain1.po1.100.0.1.0.1@15</id> 
         <version>6</version> 
         <modified>2012-09-13T19:10:50Z</modified> 
         <container>6.domain1.po1.100.0.1.0.1@15</container> 
         <created>2012-08-24T20:28:14Z</created> 
         <status> 
            <opened>1</opened> 
            <read>1</read> 
         </status> 
         <msgId>44EDB77E.domain1.po1.200.20000CB.1.14B0.1</msgId> 
         <messageId><44EDB77E.2618.00CB.0@phantom.com></messageId> 
         <source>received</source> 
         <delivered>2012-08-24T20:28:14Z</delivered> 
         <security>Normal</security> 
         <subject>new</subject> 
         <distribution> 
            <from> 
               <displayName>u1</displayName> 
               <email>u1@phantom.com</email> 
               <uuid>1DEB6970-175B-0000-890F-6E00D5004E00</uuid> 
            </from> 
            <to>u1</to> 
            <recipients> 
               <recipient> 
                  <displayName>u1</displayName> 
                  <email>u1@phantom.com</email> 
                  <uuid>1DEB6970-175B-0000-890F-6E00D5004E00</uuid> 
                  <distType>TO</distType> 
                  <recipType>User</recipType> 
               </recipient> 
            </recipients> 
            <sendoptions> 
               <statusTracking>None</statusTracking> 
            </sendoptions> 
         </distribution> 
         <message> 
            <part contentType="text/plain" length="8">YXNkZg==</part> 
         </message> 
         <options> 
            <priority>Standard</priority> 
         </options> 
         <size>991</size> 
      </item> 
   </items> 
   <status> 
      <code>0</code> 
   </status> 
</getQuickMessagesResponse>