]> code.delx.au - offlineimap/blobdiff - offlineimap.conf
Added docs for hooks
[offlineimap] / offlineimap.conf
index 996fe7a900131ef3e557f9658529471b8161b13a..6389905c4dae98e35085089cd3d2849dc8129166 100644 (file)
@@ -43,6 +43,10 @@ accounts = Test
 # greater than 1.  To force it to synchronize only one account at a
 # time, set it to 1.
 #
+# Note: if you are using autorefresh and have more than one account,
+# you must set this number to be >= to the number of accounts you have;
+# since any given sync run never "finishes" due to a timer, you will never
+# sync your additional accounts if this is 1.
 
 maxsyncaccounts = 1
 
@@ -98,6 +102,16 @@ ignore-readonly = no
 #
 # socktimeout = 60
 
+# By default, OfflineIMAP will use fsync() to force data out to disk at
+# opportune times to ensure consistency.  This can, however, reduce
+# performance.  Users where /home is on SSD (Flash) may also wish to reduce
+# write cycles.  Therefore, you can disable OfflineIMAP's use of fsync().
+# Doing so will come at the expense of greater risk of message duplication
+# in the event of a system crash or power loss.  Default is fsync = true.
+# Set fsync = false ot disable fsync.
+#
+# fsync = true
+
 ##################################################
 # Mailbox name recorder
 ##################################################
@@ -169,6 +183,19 @@ remoterepository = RemoteExample
 
 # quick = 10
 
+# You can specify a pre and post sync hook to execute a external command.
+# in this case a call to imapfilter to filter mail before the sync process
+# starts and a custom shell script after the sync completes.
+# The pre sync script has to complete before a sync to the account will
+# start. 
+
+# presynchook = imapfilter
+# postsynchook = notifysync.sh
+
+# You can also specify parameters to the commands
+# presynchook = imapfilter -c someotherconfig.lua
+
+
 [Repository LocalExample]
 
 # This is one of the two repositories that you'll work with given the
@@ -422,3 +449,13 @@ remoteuser = username@gmail.com
 #
 # See http://mail.google.com/support/bin/answer.py?answer=77657&topic=12815
 realdelete = no
+
+# The trash folder name may be different from [Gmail]/Trash
+# for example on german googlemail, this setting should be
+#
+# trashfolder = [Google Mail]/Papierkorb
+#
+# The same is valid for the spam folder
+#
+# spamfolder = [Google Mail]/Spam
+