1 # Sample configuration file
2 # Copyright (C) 2002-2005 John Goerzen
3 # <jgoerzen@complete.org>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 # Looking for a quick start? Take a look at offlineimap.conf.minimal.
22 ##################################################
24 ##################################################
28 # This specifies where offlineimap is to store its metadata.
29 # This directory will be created if it does not already exist.
31 metadata = ~/.offlineimap
33 # This variable specifies which accounts are defined. Separate them
34 # with commas. Account names should be alphanumeric only.
35 # You will need to specify one section per account below. You may
36 # not use "general" for an account name.
41 # Offlineimap can synchronize more the one account at a time. If you
42 # want to enable this feature, set the below value to something
43 # greater than 1. To force it to synchronize only one account at a
49 # You can specify one or more user interface modules for OfflineIMAP
50 # to use. OfflineIMAP will try the first in the list, and if it
51 # fails, the second, and so forth.
53 # The pre-defined options are:
54 # Curses.Blinkenlights -- A text-based (terminal) interface similar to
56 # TTY.TTYUI -- a text-based (terminal) interface
57 # Noninteractive.Basic -- Noninteractive interface suitable for cronning
58 # Noninteractive.Quiet -- Noninteractive interface, generates no output
60 # Machine.MachineUI -- Interactive interface suitable for machine
63 # You can override this with a command-line option -u.
65 ui = Curses.Blinkenlights, TTY.TTYUI,
66 Noninteractive.Basic, Noninteractive.Quiet
68 # If you try to synchronize messages to a read-only folder,
69 # OfflineIMAP will generate a warning. If you want to suppress these
70 # warnings, set ignore-readonly to yes. Read-only IMAP folders allow
71 # reading but not modification, so if you try to change messages in
72 # the local copy of such a folder, the IMAP server will prevent
73 # OfflineIMAP from propogating those changes to the IMAP server.
77 ########## Advanced settings
79 # You can give a Python source filename here and all config file
80 # python snippets will be evaluated in the context of that file.
81 # This allows you to e.g. define helper functions in the Python
82 # source file and call them from this config file. You can find
83 # an example of this in the manual.
85 # pythonfile = ~/.offlineimap.py
88 # By default, OfflineIMAP will not exit due to a network error until
89 # the operating system returns an error code. Operating systems can sometimes
90 # take forever to notice this. Here you can activate a timeout on the
91 # socket. This timeout applies to individual socket reads and writes,
92 # not to an overall sync operation. You could perfectly well have a 30s
93 # timeout here and your sync still take minutes.
95 # Values in the 30-120 second range are reasonable.
97 # The default is to have no timeout beyond the OS. Times are given in seconds.
101 ##################################################
102 # Mailbox name recorder
103 ##################################################
107 # offlineimap can record your mailbox names in a format you specify.
108 # You can define the header, each mailbox item, the separator,
109 # and the footer. Here is an example for Mutt.
110 # If enabled is yes, all six setting must be specified, even if they
111 # are just the empty string "".
113 # The header, peritem, sep, and footer are all Python expressions passed
114 # through eval, so you can (and must) use Python quoting.
117 filename = ~/Mutt/muttrc.mailboxes
118 header = "mailboxes "
119 peritem = "+%(accountname)s/%(foldername)s"
123 # You can also specify a folderfilter. It will apply to the
124 # *translated* folder name here, and it takes TWO arguments:
125 # accountname and foldername. In all other ways, it will
126 # behave identically to the folderfilter for accounts. Please see
127 # that section for more information and examples.
129 # Note that this filter can be used only to further restrict mbnames
130 # to a subset of folders that pass the account's folderfilter.
132 ##################################################
134 ##################################################
136 # This is an account definition clause. You'll have one of these
137 # for each account listed in general/accounts above.
140 ########## Basic settings
142 # These settings specify the two folders that you will be syncing.
143 # You'll need to have a "Repository ..." section for each one.
145 localrepository = LocalExample
146 remoterepository = RemoteExample
148 ########## Advanced settings
150 # You can have offlineimap continue running indefinately, automatically
151 # syncing your mail periodically. If you want that, specify how
152 # frequently to do that (in minutes) here. You can also specify
153 # fractional minutes (ie, 3.25).
157 [Repository LocalExample]
159 # This is one of the two repositories that you'll work with given the
160 # above example. Each repository requires a "type" declaration.
162 # The types supported are Maildir and IMAP.
167 # Specify local repository. Your IMAP folders will be synchronized
168 # to maildirs created under this path. OfflineIMAP will create the
169 # maildirs for you as needed.
171 localfolders = ~/Test
173 # You can specify the "path separator character" used for your Maildir
174 # folders. This is inserted in-between the components of the tree.
175 # It defaults to ".". If you want your Maildir folders to be nested,
180 # Some users on *nix platforms may not want the atime (last access
181 # time) to be modified by OfflineIMAP. In these cases, they would
182 # want to set restoreatime to yes. OfflineIMAP will make an effort
183 # to not touch the atime if you do that.
185 # In most cases, the default of no should be sufficient.
189 [Repository RemoteExample]
191 # And this is the remote repository. For now, we only support IMAP here.
195 # Specify the remote hostname.
196 remotehost = examplehost
198 # Whether or not to use SSL.
201 # Specify the port. If not specified, use a default port.
204 # Specify the remote user name.
205 remoteuser = username
207 # There are four ways to specify the password for the remote IMAP
210 # 1. No password at all specified in the config file. You will
211 # be prompted for the password when OfflineIMAP starts.
213 # 2. The remote password stored in this file with the remotepass
216 # remotepass = mypassword
218 # 3. The remote password stored as a single line in an external
219 # file, which is referenced by the remotefile option. Example:
221 # remotepassfile = ~/Password.IMAP.Account1
223 # 4. With a preauth tunnel. With this method, you invoke an external
224 # program that is guaranteed *NOT* to ask for a password, but rather
225 # to read from stdin and write to stdout an IMAP procotol stream
226 # that begins life in the PREAUTH state. When you use a tunnel,
227 # you do NOT specify a user or password (if you do, they'll be
228 # ignored.) Instead, you specify a preauthtunnel, as this
229 # example illustrates for Courier IMAP on Debian:
231 # preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
234 ########## Advanced settings
236 # Some IMAP servers need a "reference" which often refers to the
237 # "folder root". This is most commonly needed with UW IMAP, where
238 # you might need to specify the directory in which your mail is
239 # stored. Most users will not need this.
243 # OfflineIMAP can use multiple connections to the server in order
244 # to perform multiple synchronization actions simultaneously.
245 # This may place a higher burden on the server. In most cases,
246 # setting this value to 2 or 3 will speed up the sync, but in some
247 # cases, it may slow things down. The safe answer is 1. You should
248 # probably never set it to a value more than 5.
252 # OfflineIMAP normally closes IMAP server connections between refreshes if
253 # the global option autorefresh is specified. If you wish it to keep the
254 # connection open, set this to true. If not specified, the default is
255 # false. Keeping the connection open means a faster sync start the
256 # next time and may use fewer server resources on connection, but uses
257 # more server memory. This setting has no effect if autorefresh is not set.
259 holdconnectionopen = no
261 # If you want to have "keepalives" sent while waiting between syncs,
262 # specify the amount of time IN SECONDS between keepalives here. Note that
263 # sometimes more than this amount of time might pass, so don't make it
264 # tight. This setting has no effect if autorefresh and holdconnectionopen
269 # Normally, OfflineIMAP will expunge deleted messages from the server.
270 # You can disable that if you wish. This means that OfflineIMAP will
271 # mark them deleted on the server, but not actually delete them.
272 # You must use some other IMAP client to delete them if you use this
273 # setting; otherwise, the messgaes will just pile up there forever.
274 # Therefore, this setting is definately NOT recommended.
277 # You can specify a folder translator. This must be a eval-able
278 # Python expression that takes a foldername arg and returns the new
279 # value. I suggest a lambda. This example below will remove "INBOX." from
280 # the leading edge of folders (great for Courier IMAP users)
282 # WARNING: you MUST construct this such that it NEVER returns
283 # the same value for two folders, UNLESS the second values are
284 # filtered out by folderfilter below. Failure to follow this rule
285 # will result in undefined behavior
287 # nametrans = lambda foldername: re.sub('^INBOX\.', '', foldername)
289 # Using Courier remotely and want to duplicate its mailbox naming
292 # nametrans = lambda foldername: re.sub('^INBOX\.*', '.', foldername)
294 # You can specify which folders to sync. You can do it several ways.
295 # I'll provide some examples. The folderfilter operates on the
296 # *UNTRANSLATED* name, if you specify nametrans. It should return
297 # true if the folder is to be included; false otherwise.
299 # Example 1: synchronizing only INBOX and Sent.
301 # folderfilter = lambda foldername: foldername in ['INBOX', 'Sent']
303 # Example 2: synchronizing everything except Trash.
305 # folderfilter = lambda foldername: foldername not in ['Trash']
307 # Example 3: Using a regular expression to exclude Trash and all folders
308 # containing the characters "Del".
310 # folderfilter = lambda foldername: not re.search('(^Trash$|Del)', foldername)
312 # If folderfilter is not specified, ALL remote folders will be
315 # You can span multiple lines by indenting the others. (Use backslashes
316 # at the end when required by Python syntax) For instance:
318 # folderfilter = lambda foldername: foldername in
319 # ['INBOX', 'Sent Mail', 'Deleted Items',
322 # FYI, you could also include every folder with:
324 # folderfilter = lambda foldername: 1
326 # And exclude every folder with:
328 # folderfilter = lambda foldername: 0
330 # You can specify folderincludes to include additional folders.
331 # It should return a Python list. This might be used to include a
332 # folder that was excluded by your folderfilter rule, to include a
333 # folder that your server does not specify with its LIST option, or
334 # to include a folder that is outside your basic reference. Some examples:
336 # To include debian.user and debian.personal:
338 # folderincludes = ['debian.user', 'debian.personal']
340 # To include your INBOX (UW IMAPd users will find this useful if they
341 # specify a reference):
343 # folderincludes = ['INBOX']
345 # To specify a long list:
347 # folderincludes = ['box1', 'box2', 'box3', 'box4',
350 # You can specify foldersort to determine how folders are sorted.
351 # This affects order of synchronization and mbnames. The expression
352 # should return -1, 0, or 1, as the default Python cmp() does. The
353 # two arguments, x and y, are strings representing the names of the folders
354 # to be sorted. The sorting is applied *AFTER* nametrans, if any.
356 # To reverse the sort:
358 # foldersort = lambda x, y: -cmp(x, y)