From e351ab736c9771d3ede38699c13c9118a3c78907 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Sat, 4 Feb 2012 20:35:31 +0100 Subject: [PATCH] Prettify default offlineimap.conf a bit Comment out all values that are the default values and make it a bit more consistent in general. We should have a man page for those values, really. Signed-off-by: Sebastian Spaeth --- offlineimap.conf | 62 +++++++++++++++++++----------------------------- 1 file changed, 24 insertions(+), 38 deletions(-) diff --git a/offlineimap.conf b/offlineimap.conf index c7f7d9d..66dd284 100644 --- a/offlineimap.conf +++ b/offlineimap.conf @@ -1,27 +1,11 @@ -# Sample configuration file -# Copyright (C) 2002-2011 John Goerzen & contributors -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - +# Offlineimap sample configuration file # This file documents all possible options and can be quite scary. # Looking for a quick start? Take a look at offlineimap.conf.minimal. -# Settings support interpolation. This means values can contain python -# format strings which refer to other values in the same section, or -# values in a special DEFAULT section. This allows you for example to -# use common settings for multiple accounts: +# Settings generally support interpolation. This means values can +# contain python format strings which refer to other values in the same +# section, or values in a special DEFAULT section. This allows you for +# example to use common settings for multiple accounts: # # [Repository Gmail1] # trashfolder: %(gmailtrashfolder)s @@ -33,7 +17,6 @@ # gmailtrashfolder = [Google Mail]/Papierkorb # # would set the trashfolder setting for your German gmail accounts. - ################################################## @@ -45,13 +28,12 @@ # This specifies where offlineimap is to store its metadata. # This directory will be created if it does not already exist. -metadata = ~/.offlineimap +#metadata = ~/.offlineimap # This variable specifies which accounts are defined. Separate them # with commas. Account names should be alphanumeric only. # You will need to specify one section per account below. You may # not use "general" for an account name. -# accounts = Test @@ -65,7 +47,7 @@ accounts = Test # since any given sync run never "finishes" due to a timer, you will never # sync your additional accounts if this is 1. -maxsyncaccounts = 1 +#maxsyncaccounts = 1 # You can specify one or more user interface modules for OfflineIMAP # to use. OfflineIMAP will try the first in the list, and if it @@ -82,7 +64,7 @@ maxsyncaccounts = 1 # # You can override this with a command-line option -u. -ui = Blinkenlights +#ui = basic # If you try to synchronize messages to a folder which the IMAP server # considers read-only, OfflineIMAP will generate a warning. If you want @@ -92,7 +74,8 @@ ui = Blinkenlights # will prevent OfflineIMAP from propagating those changes to the IMAP # server. Note that ignore-readonly is unrelated to the "readonly" # setting which prevents a repository from being modified at all. -ignore-readonly = no + +#ignore-readonly = no ########## Advanced settings @@ -334,8 +317,9 @@ ssl = yes # fingerprint here. OfflineImap will verify that the server fingerprint # has not changed on each connect and refuse to connect otherwise. # You can also configure this in addition to CA certificate validation -# above and it will check both ways. cert_fingerprint = -# +# above and it will check both ways. + +#cert_fingerprint = # Specify the port. If not specified, use a default port. # remoteport = 993 @@ -421,7 +405,7 @@ remoteuser = username # cases, it may slow things down. The safe answer is 1. You should # probably never set it to a value more than 5. -maxconnections = 2 +#maxconnections = 2 # OfflineIMAP normally closes IMAP server connections between refreshes if # the global option autorefresh is specified. If you wish it to keep the @@ -429,15 +413,15 @@ maxconnections = 2 # false. Keeping the connection open means a faster sync start the # next time and may use fewer server resources on connection, but uses # more server memory. This setting has no effect if autorefresh is not set. - -holdconnectionopen = no +# +#holdconnectionopen = no # If you want to have "keepalives" sent while waiting between syncs, # specify the amount of time IN SECONDS between keepalives here. Note that # sometimes more than this amount of time might pass, so don't make it # tight. This setting has no effect if autorefresh and holdconnectionopen # are not both set. - +# # keepalive = 60 # Normally, OfflineIMAP will expunge deleted messages from the server. @@ -447,11 +431,12 @@ holdconnectionopen = no # setting; otherwise, the messgaes will just pile up there forever. # Therefore, this setting is definitely NOT recommended. # -# expunge = no +#expunge = no # Specify whether to process all mail folders on the server, or only # those listed as "subscribed". -subscribedonly = no +# +#subscribedonly = no # You can specify a folder translator. This must be a eval-able # Python expression that takes a foldername arg and returns the new @@ -525,7 +510,8 @@ subscribedonly = no # repository will not be modified during synchronization. Use to # e.g. backup an IMAP server. The readonly setting can be applied to any # type of Repository (Maildir, Imap, etc). -readonly = False +# +#readonly = False [Repository GmailExample] @@ -539,7 +525,6 @@ readonly = False # `remoteport`, `tunnel` and `ssl`. (See # http://mail.google.com/support/bin/answer.py?answer=78799&topic=12814) # Any attempt to set those parameters will be silently ignored. -# type = Gmail @@ -571,4 +556,5 @@ remoteuser = username@gmail.com # spamfolder = [Google Mail]/Spam # Enable 1-way synchronization. See above for explanation. -readonly = False +# +#readonly = False