]> code.delx.au - offlineimap/blobdiff - offlineimap.conf
Add IDLE support from James Bunton
[offlineimap] / offlineimap.conf
index a5b15d1dd71ca889eaa2b8c0e92d111328bc2a13..48f8f13e21483e19d83f6e19c563cd826f222505 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
@@ -185,6 +212,10 @@ type = Maildir
 
 localfolders = ~/Test
 
+# Specify whether to process all mail folders on the server, or only
+# those listed as "subscribed".
+subscribedonly = no
+
 # You can specify the "path separator character" used for your Maildir
 # folders.  This is inserted in-between the components of the tree.
 # It defaults to ".".  If you want your Maildir folders to be nested,
@@ -221,19 +252,26 @@ remotehost = examplehost
 # Whether or not to use SSL.
 ssl = yes
 
+# SSL Client certificate (optional)
+# sslclientcert = /path/to/file.crt
+
+# SSL Client key (optional)
+# sslclientkey = /path/to/file.key
+
 # Specify the port.  If not specified, use a default port.
 # remoteport = 993
 
 # Specify the remote user name.
 remoteuser = username
 
-# There are four ways to specify the password for the remote IMAP
+# There are five ways to give the password for the remote IMAP
 # server:
 #
-# 1. No password at all specified in the config file. If a matching
-#    entry is found in ~/.netrc (see netrc (5) for information) the
-#    password from the matching entry will be used. Otherwise you
-#    will be prompted for the password when OfflineIMAP starts.
+# 1. No password at all specified in the config file. If a matching entry is
+#    found in ~/.netrc (see netrc (5) for information) the password from the
+#    matching entry will be used. If there is no ~/.netrc file but there is an
+#    /etc/netrc file, the password will instead be taken from there. Otherwise 
+#    you will be prompted for the password when OfflineIMAP starts.
 #
 # 2. The remote password stored in this file with the remotepass
 #    option. Example:
@@ -255,6 +293,10 @@ remoteuser = username
 #
 # preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
 #
+# 5. If you are using Kerberos and have the Python Kerberos package installed,
+# you should not specify a remotepass.  If the user has a valid
+# Kerberos TGT, OfflineIMAP will figure out the rest all by itself, and
+# fall back to password authentication if needed.
 
 ########## Advanced settings
 
@@ -265,6 +307,19 @@ remoteuser = username
 #
 # reference = Mail
 
+# In between synchronisations, OfflineIMAP can monitor mailboxes for new
+# messages using the IDLE command. If you want to enable this, specify here
+# the folders you wish to monitor. Note that the IMAP protocol requires a
+# separate connection for each folder monitored in this way, so setting
+# this option will force settings for:
+#     maxconnections - to be at least the number of folders you give
+#     holdconnectionopen - to be true
+#     keepalive - to be 29 minutes unless you specify otherwise
+# This option should return a Python list. For example
+#
+# idlefolders = ['INBOX', 'INBOX.Alerts']
+#
+
 # OfflineIMAP can use multiple connections to the server in order
 # to perform multiple synchronization actions simultaneously.
 # This may place a higher burden on the server.  In most cases,
@@ -412,3 +467,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
+