offlineimap.conf: improve documentation for copy_ignore_eval

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Nicolas Sebrecht 2016-07-18 18:38:59 +02:00
parent 80dcf76414
commit 2f3c01f0be

View File

@ -1191,10 +1191,11 @@ remoteuser = username
# This option stands in the [Repository RemoteExample] section.
#
# If offlineiamp is having troubles to download some UIDS, it's possible to get
# them ignored in a list.
# them ignored in a list. This only ignore the download.
#
# The function must return the list of UIDs to ignore, None otherwise. It is
# passed the folder name.
# The function must return the list of UIDs (integers), None otherwise. It is
# passed the folder name (using the remote name with the remote separator,
# likely '/').
#
#copy_ignore_eval = lambda foldername: {'INBOX': [2, 3, 4]}.get(foldername)