X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/f0d48365cf737c75cceb2f4a751c3f8ec88f3063..8114877fae2003a2d305a7a264c43b8553675a05:/offlineimap.conf

diff --git a/offlineimap.conf b/offlineimap.conf
index e36a44e..de1a9d9 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -57,6 +57,8 @@ maxsyncaccounts = 1
 # Noninteractive.Basic -- Noninteractive interface suitable for cronning
 # Noninteractive.Quiet -- Noninteractive interface, generates no output
 #                         except for errors.
+# Machine.MachineUI -- Interactive interface suitable for machine
+#                      parsing.
 #
 # You can override this with a command-line option -u.
 
@@ -96,6 +98,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
 ##################################################
@@ -127,6 +139,11 @@ footer = "\n"
 # Note that this filter can be used only to further restrict mbnames
 # to a subset of folders that pass the account's folderfilter.
 
+[ui.Curses.Blinkenlights]
+# Character used to indicate thread status.
+
+statuschar = .
+
 ##################################################
 # Accounts
 ##################################################
@@ -152,6 +169,16 @@ remoterepository = RemoteExample
 
 # autorefresh = 5
 
+# You can tell offlineimap to do a number of quicker synchronizations
+# between full updates.  A quick synchronization only synchronizes
+# if a Maildir folder has changed, or if an IMAP folder has received
+# new messages or had messages deleted.  It does not update if the
+# only changes were to IMAP flags.  Specify 0 to never do quick updates,
+# -1 to always do quick updates, or a positive integer to do that many
+# quick updates between each full synchronization (requires autorefresh).
+
+# quick = 10
+
 [Repository LocalExample]
 
 # This is one of the two repositories that you'll work with given the
@@ -186,27 +213,43 @@ 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
 
+# The following can fetch the account credentials via a python expression that
+# is parsed from the pythonfile parameter. For example, a function called
+# "getcredentials" that parses a file "filename" and returns the account
+# details for "hostname".
+# remotehosteval = getcredentials("filename", "hostname", "hostname")
+# remoteusereval = getcredentials("filename", "hostname", "user")
+# remotepasseval = getcredentials("filename", "hostname", "passwd")
+
 # Specify the remote hostname.
 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:
@@ -228,6 +271,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
 
@@ -355,3 +402,33 @@ 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