Changeset 202:269a0c252f9b

Timestamp:

01/27/11 13:55:11 (16 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

Support for modifiers in the FETCH command (#62)

Files:

• NEWS (modified) (2 diffs)
• THANKS (modified) (1 diff)
• imapclient/imapclient.py (modified) (1 diff)
• livetest.py (modified) (1 diff)

NEWS

@@ +1 @@
+.. -*-Mode: rst; -*-
+
 =====
  Dev
@@ -51 +53 @@
 example.
 
-Added NAMESPACE support (#63)
------------------------------
+Added NAMESPACE support (#63) [API CHANGE]
+------------------------------------------
 namespace() method added and get_folder_delimiter() has been deprecated.
+
+Added support for FETCH modifiers (#62) [NEW]
+---------------------------------------------
+The fetch method now takes optional modifiers as the last
+argument. These are required for extensions such as RFC 4551
+(conditional store). Thanks to Thomas Jost for the patch.
 
 ===============

THANKS

@@ -18 +18 @@
     (http://www.voidspace.org.uk/python/mock/)
 
-Mark Hammond <mhammond _AT_ skipinet.com.au)
-     Much work related to response parsing.
+Mark Hammond (mhammond _AT_ skipinet.com.au)
+    Much work related to response parsing and many bug reports.
+
+Thomas Jost (schnouki _AT_ schnouki.net)
+    FETCH modifiers patch.
 
 

imapclient/imapclient.py

@@ -490 +490 @@
         @param messages: Message IDs to fetch.
         @param parts: A sequence of data items to retrieve.
-        @param modifiers: An optional sequence of modifiers.
+        @param modifiers: An optional sequence of modifiers (where
+            supported by the server, eg. ['CHANGEDSINCE 123']).
         @return: A dictionary indexed by message number. Each item is itself a
             dictionary containing the requested message parts.

livetest.py

@@ -388 +388 @@
             self.assertTrue(body.startswith('om: Bob Smith'))
 
+
+        def test_fetch_modifiers(self):
+            # CONDSTORE (RFC 4551) provides a good way to use FETCH
+            # modifiers but it isn't commonly available.
+            if not self.client.has_capability('CONDSTORE'):
+                return self.skipTest("Server doesn't support CONDSTORE")
+
+            maxModSeq = int(self.client.select_folder('INBOX')['HIGHESTMODSEQ'][0])
+            self.client.append('INBOX', SIMPLE_MESSAGE)
+            msg_id = self.client.search()[0]
+
+            resp = self.client.fetch(msg_id, ['FLAGS'], ['CHANGEDSINCE %d' % maxModSeq])
+            msg_info = resp[msg_id]
+            self.assertIn('MODSEQ', msg_info)
+
+            # Prove that the modifier is actually being used
+            resp = self.client.fetch(msg_id, ['FLAGS'], ['CHANGEDSINCE %d' % (maxModSeq + 1)])
+            self.assertFalse(resp)
+            
+
         def test_BODYSTRUCTURE(self):
             self.client.select_folder('INBOX')