# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+# Looking for a quick start? Take a look at offlineimap.conf.minimal.
+
+
##################################################
# General definitions
##################################################
accounts = Test
-# You can have offlineimap continue running indefinately, automatically
-# syncing your mail periodically. If you want that, specify how
-# frequently to do that (in minutes) here.
-
-# autorefresh = 5
-
# Offlineimap can synchronize more the one account at a time. If you
# want to enable this feature, set the below value to something
# greater than 1. To force it to synchronize only one account at a
-# time, leave it at 1.
+# time, set it to 1.
#
maxsyncaccounts = 1
# 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
#
# You can override this with a command-line option -u.
-ui = Tk.Blinkenlights, Tk.VerboseUI, TTY.TTYUI, Noninteractive.Basic,
- Noninteractive.Quiet
+ui = Tk.Blinkenlights, Tk.VerboseUI, Curses.Blinkenlights, TTY.TTYUI,
+ Noninteractive.Basic, Noninteractive.Quiet
# If you try to synchronize messages to a read-only folder,
# OfflineIMAP will generate a warning. If you want to suppress these
# You can give a Python source filename here and all config file
# python snippets will be evaluated in the context of that file.
# This allows you to e.g. define helper functions in the Python
-# source file and call them from this config file.
+# source file and call them from this config file. You can find
+# an example of this in the manual.
#
# pythonfile = ~/.offlineimap.py
#
sep = " "
footer = "\n"
+# You can also specify a folderfilter. It will apply to the
+# *translated* folder name here, and it takes TWO arguments:
+# accountname and foldername. In all other ways, it will
+# behave identically to the folderfilter for accounts. Please see
+# that section for more information and examples.
+#
+# 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
##################################################
showlog = false
+# Sets the font information.
+
+fontfamily = Helvetica
+fontsize = 8
##################################################
# Accounts
# This is an account definition clause. You'll have one of these
# for each account listed in general/accounts above.
-[Test]
-
+[Account Test]
########## Basic settings
+# These settings specify the two folders that you will be syncing.
+# You'll need to have a "Repository ..." section for each one.
+
+localrepository = LocalExample
+remoterepository = RemoteExample
+
+########## Advanced settings
+
+# You can have offlineimap continue running indefinately, automatically
+# syncing your mail periodically. If you want that, specify how
+# frequently to do that (in minutes) here. You can also specify
+# fractional minutes (ie, 3.25).
+
+# autorefresh = 5
+
+[Repository LocalExample]
+
+# This is one of the two repositories that you'll work with given the
+# above example. Each repository requires a "type" declaration.
+#
+# The types supported are Maildir and IMAP.
+#
+
+type = Maildir
+
# Specify local repository. Your IMAP folders will be synchronized
# to maildirs created under this path. OfflineIMAP will create the
# maildirs for you as needed.
localfolders = ~/Test
+# You can specify the "path separator character" used for your Maildir
+# folders. This is inserted in-between the components of the tree.
+# It defaults to ".". If you want your Maildir folders to be nested,
+# set it to "/".
+
+sep = .
+
+[Repository RemoteExample]
+
+# And this is the remote repository. For now, we only support IMAP here.
+
+type = IMAP
+
# Specify the remote hostname.
remotehost = examplehost
########## Advanced settings
-
# Some IMAP servers need a "reference" which often refers to the
# "folder root". This is most commonly needed with UW IMAP, where
# you might need to specify the directory in which your mail is
#
# reference = Mail
+# OfflineIMAP can use multiple connections to the server in order
+# to perform multiple synchronization actions simultaneously.
+# This may place a higher burden on the server. In most cases,
+# setting this value to 2 or 3 will speed up the sync, but in some
+# cases, it may slow things down. The safe answer is 1. You should
+# probably never set it to a value more than 5.
+
+maxconnections = 1
+
+# OfflineIMAP normally closes IMAP server connections between refreshes if
+# the global option autorefresh is specified. If you wish it to keep the
+# connection open, set this to true. If not specified, the default is
+# false. Keeping the connection open means a faster sync start the
+# next time and may use fewer server resources on connection, but uses
+# more server memory. This setting has no effect if autorefresh is not set.
+
+holdconnectionopen = no
+
+# If you want to have "keepalives" sent while waiting between syncs,
+# specify the amount of time IN SECONDS between keepalives here. Note that
+# sometimes more than this amount of time might pass, so don't make it
+# tight. This setting has no effect if autorefresh and holdconnectionopen
+# are not both set.
+
+# keepalive = 60
+
+# Normally, OfflineIMAP will expunge deleted messages from the server.
+# You can disable that if you wish. This means that OfflineIMAP will
+# mark them deleted on the server, but not actually delete them.
+# You must use some other IMAP client to delete them if you use this
+# setting; otherwise, the messgaes will just pile up there forever.
+# Therefore, this setting is definately NOT recommended.
+#
+# expunge = no
# You can specify a folder translator. This must be a eval-able
# Python expression that takes a foldername arg and returns the new
# value. I suggest a lambda. This example below will remove "INBOX." from
# filtered out by folderfilter below. Failure to follow this rule
# will result in undefined behavior
#
-# nametrans = lambda foldername: re.sub('^INBOX.', '', foldername)
+# 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
# You can specify foldersort to determine how folders are sorted.
# This affects order of synchronization and mbnames. The expression
-# should return -1, 0, or 1, as the default Python cmp() does.
+# should return -1, 0, or 1, as the default Python cmp() does. The
+# two arguments, x and y, are strings representing the names of the folders
+# to be sorted. The sorting is applied *AFTER* nametrans, if any.
#
# To reverse the sort:
#
# foldersort = lambda x, y: -cmp(x, y)
-
-# OfflineIMAP can use multiple connections to the server in order
-# to perform multiple synchronization actions simultaneously.
-# This may place a higher burden on the server. In most cases,
-# setting this value to 2 or 3 will speed up the sync, but in some
-# cases, it may slow things down. The safe answer is 1. You should
-# probably never set it to a value more than 5.
-
-maxconnections = 1
-
-# OfflineIMAP normally closes IMAP server connections between refreshes if
-# the global option autorefresh is specified. If you wish it to keep the
-# connection open, set this to true. If not specified, the default is
-# false. Keeping the connection open means a faster sync start the
-# next time and may use fewer server resources on connection, but uses
-# more server memory. This setting has no effect if autorefresh is not set.
-
-holdconnectionopen = no
-
-# If you want to have "keepalives" sent while waiting between syncs,
-# specify the amount of time IN SECONDS between keepalives here. Note that
-# sometimes more than this amount of time might pass, so don't make it
-# tight. This setting has no effect if autorefresh and holdconnectionopen
-# are not both set.
-
-# keepalive = 60
-
-# You can specify the "path separator character" used for your Maildir
-# folders. This is inserted in-between the components of the tree.
-# It defaults to ".". If you want your Maildir folders to be nested,
-# set it to "/".
-
-sep = .