Changeset 208:3eeca2dda55d

Timestamp:

03/23/11 00:00:36 (14 months ago)

Author:

Johannes Heckel <stone.pixel@…>

Branch:

idle

Children:

209:80f530da50d7, 212:45fab16c5bf6

Message:

Added an idle function and changed script to use imaplib2 if available.

Added example demonstrating use of idle function.

Switched the tag and keyword args when using imaplib2's _command_complete as
it expects (rqb, kw) rather than (kw, rqb).

imaplib2's untagged_responses seems to be in a list format rather than the
dictionary format imaplib uses. Now if imaplib2 is being used untagged_responses
is automatically converted to the dictionary format using a simple function.
Not sure if this is the ideal solution though.

Location:

imapclient

Files:

• examples/idle_example.py (added)
• imapclient.py (modified) (4 diffs)
• response_parser.py (modified) (1 diff)

imapclient/imapclient.py

@@ -4 +4 @@
 
 import re
-import imaplib
 import response_lexer
 from operator import itemgetter
 import warnings
+
+try:
+    import imaplib2 as imaplib
+    imaplib2 = True
+except ImportError:
+    imaplib2 = False
+    import imaplib
+    
 #imaplib.Debug = 5
-
+    
 import imap_utf7
 from fixed_offset import FixedOffset
@@ -263 +270 @@
         typ, data = self._imap.select(self._encode_folder_name(folder), readonly)
         self._checkok('select', typ, data)
-        return self._process_select_response(self._imap.untagged_responses)
-
+        if imaplib2:
+            untagged_responses = self._response_to_dict(self._imap.untagged_responses)
+        else:
+            untagged_responses = self._imap.untagged_responses
+        return self._process_select_response(untagged_responses)
+
+    def _response_to_dict(self, resp):
+        dictresp = {}
+
+        if len(resp) > 0:
+            for item in resp:
+                dictresp[item[0]] = item[1]
+
+        return dictresp
 
     def _process_select_response(self, resp):
@@ -282 +301 @@
         return out
 
-
+    def idle(self, timeout=None, **kwargs):
+        """Put server into IDLE mode.
+
+        IDLE mode will end when the server notifies of a change, the sever
+        reaches the timeout, or another IMAP4 command is scheduled.
+        
+        @param timeout: timeout for the IDLE command in seconds (default: 29 mins)
+        @param callback: Function to be called when IDLE mode ends. If a callback
+            is supplied the idle function will be asynchronous, returning immediately.
+        @param cb_arg: An optional argument that will be passed to the callback function.
+        @return: Server response. (None if callback is specified).
+        """
+        if imaplib2:
+            if 'callback' in kwargs:
+                callback = kwargs.pop('callback')
+                def _wrapped_callback(resp):
+                    typ, data = resp[0]
+                    self._checkok('idle', typ, data)
+                    # if there's a cb_arg, pass it along
+                    cb_arg = resp[1]
+                    if cb_arg:
+                        callback(data[0], cb_arg)
+                    else:
+                        callback(data[0])
+                self._imap.idle(timeout, callback=_wrapped_callback, **kwargs)
+            else:
+                typ, data = self._imap.idle(timeout)
+                self._checkok('idle', typ, data)
+                return data[0]
+        else:
+            raise self.Error('The imaplib2 module is required to use IDLE')
+                
     def folder_status(self, folder, what=None):
         """Requests the status from folder.
@@ -510 +560 @@
         else:
             tag = self._imap._command('FETCH', msg_list, parts_list, modifiers_list)
-        typ, data = self._imap._command_complete('FETCH', tag)
+        if imaplib2:
+            typ, data = self._imap._command_complete(tag, 'FETCH')
+        else:
+            typ, data = self._imap._command_complete('FETCH', tag)
         self._checkok('fetch', typ, data)
         typ, data = self._imap._untagged_response(typ, data, 'FETCH')

imapclient/response_parser.py

@@ -12 +12 @@
 #TODO more exact error reporting
 
-import imaplib
 from datetime import datetime
 from fixed_offset import FixedOffset
 from response_lexer import TokenSource
 
+try:
+    import imaplib2 as imaplib
+except ImportError:
+    imaplib2 = None
+    import imaplib
 
 __all__ = ['parse_response', 'ParseError']