X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/d839be3c61888a837bf2de52939eca9831e68dfc..6fd4962b4ccf7ab75c312743607b77d5d24e6ed2:/offlineimap.conf diff --git a/offlineimap.conf b/offlineimap.conf index 3de35fa..e7b80a8 100644 --- a/offlineimap.conf +++ b/offlineimap.conf @@ -1,5 +1,5 @@ # Sample configuration file -# Copyright (C) 2002 John Goerzen +# Copyright (C) 2002-2005 John Goerzen # # # This program is free software; you can redistribute it and/or modify @@ -51,18 +51,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 +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 ################################################## @@ -116,29 +129,10 @@ 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. +[ui.Curses.Blinkenlights] +# Character used to indicate thread status. -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 +statuschar = . ################################################## # Accounts @@ -165,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 @@ -188,12 +192,29 @@ localfolders = ~/Test sep = . +# Some users on *nix platforms may not want the atime (last access +# time) to be modified by OfflineIMAP. In these cases, they would +# want to set restoreatime to yes. OfflineIMAP will make an effort +# to not touch the atime if you do that. +# +# In most cases, the default of no should be sufficient. + +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 @@ -206,11 +227,13 @@ ssl = yes # Specify the remote user name. remoteuser = username -# There are three 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: @@ -232,6 +255,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 @@ -288,6 +315,11 @@ holdconnectionopen = no # # nametrans = lambda foldername: re.sub('^INBOX\.', '', foldername) +# Using Courier remotely and want to duplicate its mailbox naming +# locally? Try this: +# +# nametrans = lambda foldername: re.sub('^INBOX\.*', '.', foldername) + # You can specify which folders to sync. You can do it several ways. # I'll provide some examples. The folderfilter operates on the # *UNTRANSLATED* name, if you specify nametrans. It should return @@ -354,3 +386,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