X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/1e90e0fd78f2b05e4b857c902fd881e3d2d0eea5..021788524b621e6650916e5205dd0465a50792db:/offlineimap.conf

diff --git a/offlineimap.conf b/offlineimap.conf
index 01169eb..a5b15d1 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.
 
@@ -83,6 +85,19 @@ ignore-readonly = no
 # pythonfile = ~/.offlineimap.py
 #
 
+# By default, OfflineIMAP will not exit due to a network error until
+# the operating system returns an error code.  Operating systems can sometimes
+# take forever to notice this.  Here you can activate a timeout on the
+# socket.  This timeout applies to individual socket reads and writes,
+# not to an overall sync operation.  You could perfectly well have a 30s
+# timeout here and your sync still take minutes.
+#
+# Values in the 30-120 second range are reasonable.
+#
+# The default is to have no timeout beyond the OS.  Times are given in seconds.
+#
+# socktimeout = 60
+
 ##################################################
 # Mailbox name recorder
 ##################################################
@@ -114,6 +129,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
 ##################################################
@@ -139,6 +159,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
@@ -173,10 +203,18 @@ 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
 
@@ -192,8 +230,10 @@ remoteuser = username
 # There are four ways to specify 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:
@@ -342,3 +382,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