X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/54a6ce8ce6b8db3f38408a24d675ca6b2ede85ce..5c11de5285570661cb18305c033f1777f58ee920:/offlineimap.conf

diff --git a/offlineimap.conf b/offlineimap.conf
index b6ed990..b9aaecb 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -74,7 +74,7 @@ ui = Curses.Blinkenlights, TTY.TTYUI,
 # warnings, set ignore-readonly to yes.  Read-only IMAP folders allow
 # reading but not modification, so if you try to change messages in
 # the local copy of such a folder, the IMAP server will prevent
-# OfflineIMAP from propogating those changes to the IMAP server.
+# OfflineIMAP from propagating those changes to the IMAP server.
 
 ignore-readonly = no
 
@@ -166,7 +166,7 @@ remoterepository = RemoteExample
 
 ########## Advanced settings
 
-# You can have offlineimap continue running indefinately, automatically
+# You can have offlineimap continue running indefinitely, automatically
 # syncing your mail periodically.  If you want that, specify how
 # frequently to do that (in minutes) here.  You can also specify
 # fractional minutes (ie, 3.25).
@@ -183,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
@@ -199,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,
@@ -250,10 +267,11 @@ remoteuser = username
 # 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:
@@ -289,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,
@@ -431,8 +462,18 @@ remoteuser = username@gmail.com
 # continue to exist in the '[Gmail]/All Mail' folder.  If `realdelete`
 # is set to `True`, then deleted messages will really be deleted
 # during `offlineimap` sync, by moving them to the '[Gmail]/Trash'
-# folder.  BEWARE: this will deleted a messages from *all folders* it
+# folder.  BEWARE: this will delete a messages from *all folders* it
 # belongs to!
 #
 # 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
+