]> code.delx.au - offlineimap/blob - offlineimap/head/offlineimap.conf
/offlineimap/head: changeset 184
[offlineimap] / offlineimap / head / offlineimap.conf
1 # Sample configuration file
2 # Copyright (C) 2002 John Goerzen
3 # <jgoerzen@complete.org>
4 #
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.
9 #
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.
14 #
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
18
19 ##################################################
20 # General definitions
21 ##################################################
22
23 [general]
24
25 # This specifies where offlineimap is to store its metadata.
26 # This directory will be created if it does not already exist.
27
28 metadata = ~/.offlineimap
29
30 # This variable specifies which accounts are defined. Separate them
31 # with commas. Account names should be alphanumeric only.
32 # You will need to specify one section per account below. You may
33 # not use "general" for an account name.
34 #
35
36 accounts = Test
37
38 # You can have offlineimap continue running indefinately, automatically
39 # syncing your mail periodically. If you want that, specify how
40 # frequently to do that (in minutes) here.
41
42 # autorefresh = 5
43
44 # Offlineimap can synchronize more the one account at a time. If you
45 # want to enable this feature, set the below value to something
46 # greater than 1. To force it to synchronize only one account at a
47 # time, leave it at 1.
48 #
49
50 maxsyncaccounts = 1
51
52 # You can specify one or more user interface modules for OfflineIMAP
53 # to use. OfflineIMAP will try the first in the list, and if it
54 # fails, the second, and so forth.
55 #
56 # The pre-defined options are:
57 # Tk.Blinkenlights -- A graphical interface, shows LEDs and a single log
58 # Tk.VerboseUI -- A graphical interface, shows logs per thread
59 # TTY.TTYUI -- a text-based (terminal) interface
60 # Noninteractive.Basic -- Noninteractive interface suitable for cronning
61 # Noninteractive.Quiet -- Noninteractive interface, generates no output
62 # except for errors.
63 #
64 # You can override this with a command-line option -u.
65
66 ui = Tk.Blinkenlights, Tk.VerboseUI, TTY.TTYUI, Noninteractive.Basic,
67 Noninteractive.Quiet
68
69
70 ##################################################
71 # Mailbox name recorder
72 ##################################################
73
74 [mbnames]
75
76 # offlineimap can record your mailbox names in a format you specify.
77 # You can define the header, each mailbox item, the separator,
78 # and the footer. Here is an example for Mutt.
79 # If enabled is yes, all six setting must be specified, even if they
80 # are just the empty string "".
81 #
82 # The header, peritem, sep, and footer are all Python expressions passed
83 # through eval, so you can (and must) use Python quoting.
84
85 enabled = no
86 filename = ~/Mutt/muttrc.mailboxes
87 header = "mailboxes "
88 peritem = "+%(accountname)s/%(foldername)s"
89 sep = " "
90 footer = "\n"
91
92 ##################################################
93 # Blinkenlights configuration
94 ##################################################
95
96 [ui.Tk.Blinkenlights]
97
98 # Specifies the default number of lines in the log.
99
100 loglines = 5
101
102 # If true, says that the log should be enabled by default.
103 # Otherwise, you have to click "Show Log" to enable the log.
104
105 showlog = false
106
107 ##################################################
108 # Accounts
109 ##################################################
110
111 # This is an account definition clause. You'll have one of these
112 # for each account listed in general/accounts above.
113
114 [Test]
115
116 ########## Basic settings
117
118 # Specify local repository. Your IMAP folders will be synchronized
119 # to maildirs created under this path. OfflineIMAP will create the
120 # maildirs for you as needed.
121
122 localfolders = ~/Test
123
124 # Specify the remote hostname.
125 remotehost = examplehost
126
127 # Whether or not to use SSL.
128 ssl = yes
129
130 # Specify the port. If not specified, use a default port.
131 # remoteport = 993
132
133 # Specify the remote user name.
134 remoteuser = username
135
136 # There are three ways to specify the password for the remote IMAP
137 # server:
138 #
139 # 1. No password at all specified in the config file. You will
140 # be prompted for the password when OfflineIMAP starts.
141 #
142 # 2. The remote password stored in this file with the remotepass
143 # option. Example:
144 #
145 # remotepass = mypassword
146 #
147 # 3. The remote password stored as a single line in an external
148 # file, which is referenced by the remotefile option. Example:
149 #
150 # remotepassfile = ~/Password.IMAP.Account1
151 #
152 # 4. With a preauth tunnel. With this method, you invoke an external
153 # program that is guaranteed *NOT* to ask for a password, but rather
154 # to read from stdin and write to stdout an IMAP procotol stream
155 # that begins life in the PREAUTH state. When you use a tunnel,
156 # you do NOT specify a user or password (if you do, they'll be
157 # ignored.) Instead, you specify a preauthtunnel, as this
158 # example illustrates for Courier IMAP on Debian:
159 #
160 # preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
161 #
162
163 ########## Advanced settings
164
165
166 # Some IMAP servers need a "reference" which often refers to the
167 # "folder root". This is most commonly needed with UW IMAP, where
168 # you might need to specify the directory in which your mail is
169 # stored. Most users will not need this.
170 #
171 # reference = Mail
172
173 # You can specify a folder translator. This must be a eval-able
174 # Python expression that takes a foldername arg and returns the new
175 # value. I suggest a lambda. This example below will remove "INBOX." from
176 # the leading edge of folders (great for Courier IMAP users)
177 #
178 # WARNING: you MUST construct this such that it NEVER returns
179 # the same value for two folders, UNLESS the second values are
180 # filtered out by folderfilter below. Failure to follow this rule
181 # will result in undefined behavior
182 #
183 # nametrans = lambda foldername: re.sub('^INBOX.', '', foldername)
184
185 # You can specify which folders to sync. You can do it several ways.
186 # I'll provide some examples. The folderfilter operates on the
187 # *UNTRANSLATED* name, if you specify nametrans. It should return
188 # true if the folder is to be included; false otherwise.
189 #
190 # Example 1: synchronizing only INBOX and Sent.
191 #
192 # folderfilter = lambda foldername: foldername in ['INBOX', 'Sent']
193 #
194 # Example 2: synchronizing everything except Trash.
195 #
196 # folderfilter = lambda foldername: foldername not in ['Trash']
197 #
198 # Example 3: Using a regular expression to exclude Trash and all folders
199 # containing the characters "Del".
200 #
201 # folderfilter = lambda foldername: not re.search('(^Trash$|Del)', foldername)
202 #
203 # If folderfilter is not specified, ALL remote folders will be
204 # synchronized.
205 #
206 # You can span multiple lines by indenting the others. (Use backslashes
207 # at the end when required by Python syntax) For instance:
208 #
209 # folderfilter = lambda foldername: foldername in
210 # ['INBOX', 'Sent Mail', 'Deleted Items',
211 # 'Received']
212 #
213 # FYI, you could also include every folder with:
214 #
215 # folderfilter = lambda foldername: 1
216 #
217 # And exclude every folder with:
218 #
219 # folderfilter = lambda foldername: 0
220
221 # You can specify folderincludes to include additional folders.
222 # It should return a Python list. This might be used to include a
223 # folder that was excluded by your folderfilter rule, to include a
224 # folder that your server does not specify with its LIST option, or
225 # to include a folder that is outside your basic reference. Some examples:
226 #
227 # To include debian.user and debian.personal:
228 #
229 # folderincludes = ['debian.user', 'debian.personal']
230 #
231 # To include your INBOX (UW IMAPd users will find this useful if they
232 # specify a reference):
233 #
234 # folderincludes = ['INBOX']
235 #
236 # To specify a long list:
237 #
238 # folderincludes = ['box1', 'box2', 'box3', 'box4',
239 # 'box5', 'box6']
240
241
242 # OfflineIMAP can use multiple connections to the server in order
243 # to perform multiple synchronization actions simultaneously.
244 # This may place a higher burden on the server. In most cases,
245 # setting this value to 2 or 3 will speed up the sync, but in some
246 # cases, it may slow things down. The safe answer is 1. You should
247 # probably never set it to a value more than 5.
248
249 maxconnections = 1
250
251 # OfflineIMAP normally closes IMAP server connections between refreshes if
252 # the global option autorefresh is specified. If you wish it to keep the
253 # connection open, set this to true. If not specified, the default is
254 # false. Keeping the connection open means a faster sync start the
255 # next time and may use fewer server resources on connection, but uses
256 # more server memory. This setting has no effect if autorefresh is not set.
257
258 holdconnectionopen = no
259
260 # If you want to have "keepalives" sent while waiting between syncs,
261 # specify the amount of time IN SECONDS between keepalives here. Note that
262 # sometimes more than this amount of time might pass, so don't make it
263 # tight. This setting has no effect if autorefresh and holdconnectionopen
264 # are not both set.
265
266 # keepalive = 60