tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

IMAP IDLE cleanup(2): Add code documentation

Browse Source 
Add code documentation throughout the idle() function.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Sebastian Spaeth 2011-09-12 10:37:54 +02:00 committed by Nicolas Sebrecht
parent f369961a87
commit 0bebd65ba0
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
offlineimap/imapserver.py
View File

@ -456,6 +456,9 @@ class IMAPServer:
class IdleThread(object): class IdleThread(object):
def __init__(self, parent, folder=None): def __init__(self, parent, folder=None):
"""If invoked without 'folder', perform a NOOP and wait for
self.stop() to be called. If invoked with folder, switch to IDLE
mode and synchronize once we have a new message"""
self.parent = parent self.parent = parent
self.folder = folder self.folder = folder
self.event = Event() self.event = Event()
@ -493,7 +496,14 @@ class IdleThread(object):
ui.unregisterthread(currentThread()) ui.unregisterthread(currentThread())
def idle(self): def idle(self):
"""Invoke IDLE mode until timeout or self.stop() is invoked"""
def callback(args): def callback(args):
"""IDLE callback function invoked by imaplib2
This is invoked when a) The IMAP server tells us something
while in IDLE mode, b) we get an Exception (e.g. on dropped
connections, or c) the standard imaplib IDLE timeout of 29
minutes kicks in."""
result, cb_arg, exc_data = args result, cb_arg, exc_data = args
if exc_data is None: if exc_data is None:
if not self.event.isSet(): if not self.event.isSet():
@ -527,10 +537,8 @@ class IdleThread(object):
if "IDLE" in imapobj.capabilities: if "IDLE" in imapobj.capabilities:
imapobj.idle(callback=callback) imapobj.idle(callback=callback)
else: else:
self.ui.warn("IMAP IDLE not supported on connection to %s." self.ui.warn("IMAP IDLE not supported on server '%s'."
"Falling back to old behavior: sleeping until next" "Sleep until next refresh cycle." % imapobj.identifier)
"refresh cycle."
%(imapobj.identifier,))
imapobj.noop() imapobj.noop()
self.event.wait() self.event.wait()
if self.event.isSet(): if self.event.isSet():
@ -541,5 +549,7 @@ class IdleThread(object):
# of the loop next time around. # of the loop next time around.
self.parent.releaseconnection(imapobj) self.parent.releaseconnection(imapobj)
if self.needsync: if self.needsync:
# here not via self.stop, but because IDLE responded. Do
# another round and invoke actual syncing.
self.event.clear() self.event.clear()
self.dosync() self.dosync()