X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/ac7c5a47efc80baa0270d949b72e596e5b25129b..140be81efd72f3a78fa175e744bb761731cb6d71:/offlineimap.conf

diff --git a/offlineimap.conf b/offlineimap.conf
index 9263df7..6e12296 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -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
 ##################################################
@@ -203,7 +217,7 @@ restoreatime = no
 
 [Repository RemoteExample]
 
-# And this is the remote repository.  For now, we only support IMAP here.
+# And this is the remote repository.  We only support IMAP or Gmail here.
 
 type = IMAP
 
@@ -221,17 +235,25 @@ 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.  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. Otherwise you
+#    will be prompted for the password when OfflineIMAP starts.
 #
 # 2. The remote password stored in this file with the remotepass
 #    option. Example:
@@ -253,6 +275,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
 
@@ -380,3 +406,43 @@ holdconnectionopen = no
 #
 # foldersort = lambda x, y: -cmp(x, y)
 
+
+[Repository GmailExample]
+
+# A repository using Gmail's IMAP interface.  Any configuration
+# parameter of `IMAP` type repositories can be used here.  Only
+# `remoteuser` (or `remoteusereval` ) is mandatory.  Default values
+# for other parameters are OK, and you should not need fiddle with
+# those.
+#
+# The Gmail repository will use hard-coded values for `remotehost`,
+# `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
+
+# Specify the Gmail user name. This is the only mandatory parameter.
+remoteuser = username@gmail.com
+
+# Deleting a message from a Gmail folder via the IMAP interface will
+# just remove that folder's label from the message: the message will
+# 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
+# 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
+