X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/71c8b2e7c489b6277dd862e9174784ca237ebead..936fe1f43e9ded5ae66b59cb39e6c8d188e637a4:/offlineimap.conf diff --git a/offlineimap.conf b/offlineimap.conf index cdba6a7..6389905 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 @@ -51,18 +55,18 @@ maxsyncaccounts = 1 # fails, the second, and so forth. # # The pre-defined options are: -# Tk.Blinkenlights -- A graphical interface, shows LEDs and a single log -# Tk.VerboseUI -- A graphical interface, shows logs per thread # Curses.Blinkenlights -- A text-based (terminal) interface similar to # Tk.Blinkenlights # TTY.TTYUI -- a text-based (terminal) interface # 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. -ui = Tk.Blinkenlights, Tk.VerboseUI, Curses.Blinkenlights, TTY.TTYUI, +ui = Curses.Blinkenlights, TTY.TTYUI, Noninteractive.Basic, Noninteractive.Quiet # If you try to synchronize messages to a read-only folder, @@ -85,6 +89,29 @@ 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 + +# 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 ################################################## @@ -116,34 +143,8 @@ 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. -################################################## -# Blinkenlights configuration -################################################## - -[ui.Tk.Blinkenlights] - -# Specifies the default number of lines in the log. - -loglines = 5 - -# Specifies how many lines are in the scrollback log buffer. - -bufferlines = 500 - -# If true, says that the log should be enabled by default. -# Otherwise, you have to click "Show Log" to enable the log. - -showlog = false - -# Sets the font information. - -fontfamily = Helvetica -fontsize = 8 - [ui.Curses.Blinkenlights] - -# Character used to indicate thread status, in place of -# the LEDs from Tk.Blinkenlights +# Character used to indicate thread status. statuschar = . @@ -172,6 +173,29 @@ 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 + +# 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 @@ -206,27 +230,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: @@ -248,6 +288,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 @@ -375,3 +419,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 +