Improve documentation on "reference" option

It was not clear how the reference value is used. Improve this by exposing
the internal path build system for the 'reference' option so that users
know what value is expected.
Also, explain how it impacts both nametrans and folderfilter options.

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-03-03 10:39:54 +01:00 committed by Nicolas Sebrecht
parent d7210f3ccd
commit b293e91a0e

View File

@ -327,10 +327,14 @@ remoteuser = username
########## Advanced settings ########## Advanced settings
# Some IMAP servers need a "reference" which often refers to the # Some IMAP servers need a "reference" which often refers to the "folder
# "folder root". This is most commonly needed with UW IMAP, where # root". This is most commonly needed with UW IMAP, where you might
# you might need to specify the directory in which your mail is # need to specify the directory in which your mail is stored. The
# stored. Most users will not need this. # 'reference' value will be prefixed to all folder paths refering to
# that repository. E.g. accessing folder 'INBOX' with reference = Mail
# will try to access Mail/INBOX. Note that the nametrans and
# folderfilter functions will still apply the full path including the
# reference prefix. Most users will not need this.
# #
# reference = Mail # reference = Mail