[PATCH] Improve documentation on quick syncs

Sebastian Spaeth Sebastian at SSpaeth.de
Wed Apr 13 09:48:51 BST 2011

From: dtk <d.t.k at gmx.de>

Make clear that quick syncs do not happen inbetween full syncs (ie they
are part of the regular autorefresh intervals and don't happen within
them). This part of the documentation had confused many.

Modified-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
This is a cleanup of the documentation against current master.
In the long run, I would love to be able to use "quick" syncs even in
the non-autorefresh mode by caching the "quick" count status of a folder
and invoke quick or full syncs based on that. But that requires some 
infrastructure work first.

 offlineimap.conf |   18 +++++++++++-------
 1 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/offlineimap.conf b/offlineimap.conf
index 987b6b4..6e8ef2d 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -171,13 +171,17 @@ remoterepository = RemoteExample
 # autorefresh = 5
-# You can tell offlineimap to do a number of quicker synchronizations
-# between full updates.  A quick synchronization only synchronizes
-# if a Maildir folder has changed, or if an IMAP folder has received
-# new messages or had messages deleted.  It does not update if the
-# only changes were to IMAP flags.  Specify 0 to never do quick updates,
-# -1 to always do quick updates, or a positive integer to do that many
-# quick updates between each full synchronization (requires autorefresh).
+# OfflineImap can replace a number of full updates by quick
+# synchronizations.  It only synchronizes a folder if 1) a Maildir
+# folder has changed, or 2) if an IMAP folder has received new messages
+# or had messages deleted, ie it not update if only IMAP flags have
+# changed.  Full updates need to fetch ALL flags for all messages, so
+# this makes quite a performance difference (especially if syncing
+# between two IMAP servers).
+# Specify 0 for never, -1 for always (works even in non-autorefresh
+# mode), or a positive integer <n> to do <n> quick updates before doing
+# another full synchronization (requires autorefresh).  Updates are
+# always performed after <autorefresh> minutes, be they quick or full.
 # quick = 10

More information about the OfflineIMAP-project mailing list