Improve folderfilters documentation

The text was confusing and not very helpful. Do away with the bad
folderfilters examples and describe a bit more what they are for.

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-08-25 10:18:03 +02:00 committed by Nicolas Sebrecht
parent dcc50efc4f
commit 1fc64f4c19
1 changed files with 7 additions and 12 deletions

View File

@ -443,10 +443,12 @@ subscribedonly = no
# #
# nametrans = lambda foldername: re.sub('^INBOX\.*', '.', foldername) # nametrans = lambda foldername: re.sub('^INBOX\.*', '.', foldername)
# You can specify which folders to sync. You can do it several ways. # You can specify which folders to sync using the folderfilter
# I'll provide some examples. The folderfilter operates on the # setting. You can provide any python function (e.g. a lambda function)
# *UNTRANSLATED* name, if you specify nametrans. It should return # which will be invoked for each foldername. If the filter function
# true if the folder is to be included; false otherwise. # returns True, the folder will be synced, if it returns False, it. The
# folderfilter operates on the *UNTRANSLATED* name (before any nametrans
# translation takes place).
# #
# Example 1: synchronizing only INBOX and Sent. # Example 1: synchronizing only INBOX and Sent.
# #
@ -470,14 +472,7 @@ subscribedonly = no
# folderfilter = lambda foldername: foldername in # folderfilter = lambda foldername: foldername in
# ['INBOX', 'Sent Mail', 'Deleted Items', # ['INBOX', 'Sent Mail', 'Deleted Items',
# 'Received'] # 'Received']
#
# FYI, you could also include every folder with:
#
# folderfilter = lambda foldername: 1
#
# And exclude every folder with:
#
# folderfilter = lambda foldername: 0
# You can specify folderincludes to include additional folders. # You can specify folderincludes to include additional folders.
# It should return a Python list. This might be used to include a # It should return a Python list. This might be used to include a