root / FAQ.html

1 83dfc24c John
 <!DOCTYPE html
2 83dfc24c John
     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 83dfc24c John
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 83dfc24c John
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 83dfc24c John
 <head>
6 83dfc24c John
  <title>FrequentlyAskedQuestions - OfflineIMAP</title><link rel="start" href="/offlineimap/wiki" /><link rel="search" href="/offlineimap/search" /><link rel="help" href="/offlineimap/wiki/TracGuide" /><link rel="stylesheet" href="/static/css/trac.css" type="text/css" /><link rel="stylesheet" href="/static/css/wiki.css" type="text/css" /><link rel="icon" href="/offlineimap/chrome/common/trac.ico" type="image/x-icon" /><link rel="shortcut icon" href="/offlineimap/chrome/common/trac.ico" type="image/x-icon" /><link rel="alternate" href="/offlineimap/wiki/FrequentlyAskedQuestions?format=txt" title="Plain Text" type="text/x-trac-wiki" /><style type="text/css">
7 83dfc24c John
 #adbar {
8 83dfc24c John
   position: absolute;
9 83dfc24c John
   top: 152px;
10 83dfc24c John
   right: 10px;
11 83dfc24c John
   width: 140px;
12 83dfc24c John
   z-index: 1;
13 83dfc24c John
   text-align: right;
14 83dfc24c John
 }
15 83dfc24c John
16 83dfc24c John
 /* For Mozilla and Safari */
17 83dfc24c John
 *>#content {
18 83dfc24c John
         padding: 0;
19 83dfc24c John
         margin: 15px 140px 0 15px;
20 83dfc24c John
         text-align: left;
21 83dfc24c John
         min-height: 770px;
22 83dfc24c John
 }
23 83dfc24c John
 #header h1 { margin:  0 0 -4.5em; }
24 83dfc24c John
25 83dfc24c John
 *>#jg-content { background: #fff; padding-left: 10px; }
26 83dfc24c John
27 83dfc24c John
 /* For IE */
28 83dfc24c John
 * html #content {
29 83dfc24c John
         padding: 0;
30 83dfc24c John
         margin: 15px 140px 0 15px;
31 83dfc24c John
         text-align: left;
32 83dfc24c John
         height: 770px;
33 83dfc24c John
 }
34 83dfc24c John
 * html #jg-content { background: #fff; padding-left: 10px; }
35 83dfc24c John
 * html #header h1 {margin: 0 0 0; }
36 83dfc24c John
37 83dfc24c John
 body { background: #404040; }
38 83dfc24c John
39 83dfc24c John
 /* #dirlist td.change { white-space: normal; } */
40 83dfc24c John
 /* #dirlist td.name { width: auto; } */
41 83dfc24c John
42 83dfc24c John
 </style>
43 83dfc24c John
  <script type="text/javascript" src="/static/js/trac.js"></script>
44 83dfc24c John
 </head>
45 83dfc24c John
 <body>
46 83dfc24c John
47 83dfc24c John
48 83dfc24c John
 <div id="jg-content">
49 83dfc24c John
50 83dfc24c John
51 83dfc24c John
 <div id="banner">
52 83dfc24c John
53 83dfc24c John
 <div id="header"><h1><a href="http://software.complete.org/offlineimap/">OfflineIMAP</a> - FrequentlyAskedQuestions
54 83dfc24c John
   </h1><br/></div>
55 83dfc24c John
56 83dfc24c John
 <form id="search" action="/offlineimap/search" method="get">
57 83dfc24c John
  <div>
58 83dfc24c John
   <label for="proj-search">Search:</label>
59 83dfc24c John
   <input type="text" id="proj-search" name="q" size="10" accesskey="f" value="" />
60 83dfc24c John
   <input type="submit" value="Search" />
61 83dfc24c John
   <input type="hidden" name="wiki" value="on" />
62 83dfc24c John
   <input type="hidden" name="changeset" value="on" />
63 83dfc24c John
   <input type="hidden" name="ticket" value="on" />
64 83dfc24c John
  </div>
65 83dfc24c John
 </form>
66 83dfc24c John
67 83dfc24c John
68 83dfc24c John
69 83dfc24c John
 <div id="metanav" class="nav"><ul><li class="first"><a href="/offlineimap/login">Login</a></li><li><a href="/offlineimap/settings">Settings</a></li><li><a accesskey="6" href="/offlineimap/wiki/TracGuide">Help/Guide</a></li><li><a href="/offlineimap/about">About Trac</a></li><li class="last"><a href="/offlineimap/register">Register</a></li></ul></div>
70 83dfc24c John
 </div>
71 83dfc24c John
72 83dfc24c John
 <div id="mainnav" class="nav"><ul><li class="active first"><a accesskey="1" href="/offlineimap/wiki">Wiki</a></li><li><a accesskey="2" href="/offlineimap/timeline">Timeline</a></li><li><a accesskey="3" href="/offlineimap/roadmap">Roadmap</a></li><li><a href="/offlineimap/browser">Browse Source</a></li><li><a href="/offlineimap/report">View Tickets</a></li><li><a accesskey="4" href="/offlineimap/search">Search</a></li><li class="last"><a href="/offlineimap/downloads">Downloads</a></li></ul></div>
73 83dfc24c John
 <div id="main">
74 83dfc24c John
75 83dfc24c John
76 83dfc24c John
77 83dfc24c John
78 83dfc24c John
 <div id="ctxtnav" class="nav">
79 83dfc24c John
  <h2>Wiki Navigation</h2>
80 83dfc24c John
  <ul>
81 83dfc24c John
    <li><a href="/offlineimap/wiki">Start Page</a></li>
82 83dfc24c John
    <li><a href="/offlineimap/wiki/TitleIndex">Index by Title</a></li>
83 83dfc24c John
    <li><a href="/offlineimap/wiki/RecentChanges">Index by Date</a></li>
84 83dfc24c John
    <li class="last"><a href="/offlineimap/wiki/FrequentlyAskedQuestions?action=diff&amp;version=14">Last Change</a></li>
85 83dfc24c John
  </ul>
86 83dfc24c John
  <hr />
87 83dfc24c John
 </div>
88 83dfc24c John
89 83dfc24c John
 <div id="content" class="wiki">
90 83dfc24c John
91 83dfc24c John
92 83dfc24c John
93 83dfc24c John
94 83dfc24c John
95 83dfc24c John
    <div class="wikipage">
96 83dfc24c John
     <div id="searchable"><h1 id="OfflineIMAPFAQ">OfflineIMAP FAQ</h1>
97 83dfc24c John
 <p>
98 83dfc24c John
 Here are answers to some of the most frequently asked questions about OfflineIMAP.
99 83dfc24c John
 </p>
100 83dfc24c John
 <hr />
101 83dfc24c John
 <p>
102 83dfc24c John
 <ol><li><a href="#BasicQuestions">Basic Questions</a><ol><li><a href="#WheredoIgetOfflineIMAP">Where do I get OfflineIMAP?</a></li><li>
103 83dfc24c John
 <a href="#Howfastisit">How fast is it?</a></li><li>
104 83dfc24c John
 <a href="#WhatplatformsdoesOfflineIMAPsupport">What platforms does OfflineIMAP support?</a><ol><li><a href="#UseonWindows">Use on Windows</a></li></ol><li><a href="#DoesOfflineIMAPsupportmboxmhoranythingelseotherthanMaildir">Does OfflineIMAP support mbox, mh, or anything else other than Maildir?</a></li><li>
105 83dfc24c John
 <a href="#HowdoIaddordeleteafolder">How do I add or delete a folder?</a></li><li>
106 83dfc24c John
 <a href="#DoesOfflineIMAPsupportPOP">Does OfflineIMAP support POP?</a></li></ol><li><a href="#ConfigurationQuestions">Configuration Questions</a><ol><li><a href="#CanIsynchronizemultipleaccountswithOfflineIMAP">Can I synchronize multiple accounts with OfflineIMAP?</a></li><li>
107 83dfc24c John
 <a href="#HowdoIspecifythenamesoffolders">How do I specify the names of folders?</a></li><li>
108 83dfc24c John
 <a href="#HowdoIpreventcertainfoldersfrombeingsynced">How do I prevent certain folders from being synced?</a></li><li>
109 83dfc24c John
 <a href="#Whatisthemailboxnamerecordermbnamesfor">What is the mailbox name recorder (mbnames) for?</a></li></ol><li><a href="#IMAPServerNotes">IMAP Server Notes</a><ol><li><a href="#MicrosoftExchange">Microsoft Exchange</a></li></ol><li><a href="#ClientNotes">Client Notes</a><ol><li><a href="#WhatclientsdoesOfflineIMAPworkwith">What clients does OfflineIMAP work with?</a></li><li>
110 83dfc24c John
 <a href="#Evolution">Evolution</a></li><li>
111 83dfc24c John
 <a href="#KMail">KMail</a></li><li>
112 83dfc24c John
 <a href="#Mutt">Mutt</a><ol><li><a href="#DoIneedtousesetmaildir_trash">Do I need to use set maildir_trash?</a></li><li>
113 83dfc24c John
 <a href="#HowdoIsetupmbnameswithmutt">How do I set up mbnames with mutt?</a></li></ol><li></li></ol><li><a href="#MiscellaneousQuestions">Miscellaneous Questions</a><ol><li><a href="#WhyareyourMaildirmessagefilenamessolong">Why are your Maildir message filenames so long?</a></li></ol></li></ol></li></ol>
114 83dfc24c John
 </p>
115 83dfc24c John
 <hr />
116 83dfc24c John
 <h2 id="BasicQuestions">Basic Questions</h2>
117 83dfc24c John
 <h3 id="WheredoIgetOfflineIMAP">Where do I get OfflineIMAP?</h3>
118 83dfc24c John
 <p>
119 83dfc24c John
 From its <a href="/offlineimap/downloads">downloads page</a>.
120 83dfc24c John
 </p>
121 83dfc24c John
 <h3 id="Howfastisit">How fast is it?</h3>
122 83dfc24c John
 <p>
123 83dfc24c John
 OfflineIMAP has a multithreaded sync, so it should have very nice performance.
124 83dfc24c John
 </p>
125 83dfc24c John
 <p>
126 83dfc24c John
 OfflineIMAP versions 2.0 and above contain a multithreaded system. A good way to experiment is by setting maxsyncaccounts to 3 and maxconnections to 3 in each account clause.
127 83dfc24c John
 </p>
128 83dfc24c John
 <p>
129 83dfc24c John
 This lets OfflineIMAP open up multiple connections simultaneously. That will let it process multiple folders and messages at once. In most cases, this will increase performance of the sync.
130 83dfc24c John
 </p>
131 83dfc24c John
 <p>
132 83dfc24c John
 Don't set the number too high. If you do that, things might actually slow down as your link gets saturated. Also, too many connections can cause mail servers to have excessive load. Administrators might take unkindly to this, and the server might bog down. There are many variables in the optimal setting; experimentation may help.
133 83dfc24c John
 </p>
134 83dfc24c John
 <p>
135 83dfc24c John
 An informal benchmark yields these results for my setup:
136 83dfc24c John
 </p>
137 83dfc24c John
 <ul><li>10 minutes with MacOS X Mail.app "manual cache"
138 83dfc24c John
 </li><li>5 minutes with GNUS agent sync
139 83dfc24c John
 </li><li>20 seconds with OfflineIMAP 1.x
140 83dfc24c John
 </li><li>9 seconds with OfflineIMAP 2.x
141 83dfc24c John
 </li><li>3 seconds with OfflineIMAP 3.x "cold start"
142 83dfc24c John
 </li><li>2 seconds with OfflineIMAP 3.x "held connection"
143 83dfc24c John
 </li></ul><h3 id="WhatplatformsdoesOfflineIMAPsupport">What platforms does OfflineIMAP support?</h3>
144 83dfc24c John
 <p>
145 83dfc24c John
 It should run on most platforms supported by Python, which are quite a few. I do not support Windows myself, but some have made it work there.
146 83dfc24c John
 </p>
147 83dfc24c John
 <h4 id="UseonWindows">Use on Windows</h4>
148 83dfc24c John
 <p>
149 83dfc24c John
 These answers have been reported by OfflineIMAP  users. I do not run OfflineIMAP on Windows myself, so I can't directly address their accuracy.
150 83dfc24c John
 </p>
151 83dfc24c John
 <p>
152 83dfc24c John
 The basic answer is that it's possible and doesn't require hacking OfflineIMAP source code. However, it's not necessarily trivial. The information below is based in instructions submitted by Chris Walker.
153 83dfc24c John
 </p>
154 83dfc24c John
 <p>
155 83dfc24c John
 First, you must run OfflineIMAP in the <a class="ext-link" href="http://www.cygwin.com/"><span class="icon">Cygwin</span></a> environment.  The Windows filesystem is not powerful enough to accomodate Maildir by itself.
156 83dfc24c John
 </p>
157 83dfc24c John
 <p>
158 83dfc24c John
 Next, you'll need to mount your Maildir directory in a special way. There is information for doing that at <a class="ext-link" href="http://barnson.org/node/view/295"><span class="icon">http://barnson.org/node/view/295</span></a>. That site gives this example:
159 83dfc24c John
 </p>
160 83dfc24c John
 <pre class="wiki">mount -f -s -b -o managed "d:/tmp/mail" "/home/of/mail"
161 83dfc24c John
 </pre><p>
162 83dfc24c John
163 83dfc24c John
 That URL also has more details on making OfflineIMAP work with Windows.
164 83dfc24c John
 </p>
165 83dfc24c John
 <h3 id="DoesOfflineIMAPsupportmboxmhoranythingelseotherthanMaildir">Does OfflineIMAP support mbox, mh, or anything else other than Maildir?</h3>
166 83dfc24c John
 <p>
167 83dfc24c John
 Not directly.  Maildir was the easiest to implement.  I'm not planning to write mbox code for OfflineIMAP, though if someone sent me well-written mbox support and pledged to support it, I'd commit it to the tree.
168 83dfc24c John
 </p>
169 83dfc24c John
 <p>
170 83dfc24c John
 However, OfflineIMAP can directly sync accounts on two different IMAP servers together.  So you could install an IMAP server on your local machine that supports mbox, sync to it, and then instruct your mail readers to use the mboxes.
171 83dfc24c John
 </p>
172 83dfc24c John
 <p>
173 83dfc24c John
 Or you could install whatever IMAP server you like on the local machine, and point your mail readers to that IMAP server on localhost.
174 83dfc24c John
 </p>
175 83dfc24c John
 <h3 id="HowdoIaddordeleteafolder">How do I add or delete a folder?</h3>
176 83dfc24c John
 <p>
177 83dfc24c John
 OfflineIMAP does not currently provide this feature.  However, if you create a new folder on the remote server, OfflineIMAP will detect this and create the corresponding folder locally automatically.
178 83dfc24c John
 </p>
179 83dfc24c John
 <h3 id="DoesOfflineIMAPsupportPOP">Does OfflineIMAP support POP?</h3>
180 83dfc24c John
 <p>
181 83dfc24c John
 No.  POP is not robust enough to do a completely reliable multi-machine sync like OfflineIMAP can do.
182 83dfc24c John
 </p>
183 83dfc24c John
 <p>
184 83dfc24c John
 OfflineIMAP will never support POP.
185 83dfc24c John
 </p>
186 83dfc24c John
 <h2 id="ConfigurationQuestions">Configuration Questions</h2>
187 83dfc24c John
 <h3 id="CanIsynchronizemultipleaccountswithOfflineIMAP">Can I synchronize multiple accounts with OfflineIMAP?</h3>
188 83dfc24c John
 <p>
189 83dfc24c John
 Of course!
190 83dfc24c John
 </p>
191 83dfc24c John
 <p>
192 83dfc24c John
 Just name them all in the accounts line in the general section of the configuration file, and add a per-account section for each one.
193 83dfc24c John
 </p>
194 83dfc24c John
 <p>
195 83dfc24c John
 You can also optionally use the -a option when you run OfflineIMAP to request that it only operate upon a subset of the accounts for a particular run.
196 83dfc24c John
 </p>
197 83dfc24c John
 <h3 id="HowdoIspecifythenamesoffolders">How do I specify the names of folders?</h3>
198 83dfc24c John
 <p>
199 83dfc24c John
 You do not need to.  OfflineIMAP is smart enough to automatically figure out what folders are present on the IMAP server and synchronize them.  You can use the folderfilter and nametrans configuration file options to request only certain folders and rename them as they come in if you like.
200 83dfc24c John
 </p>
201 83dfc24c John
 <h3 id="HowdoIpreventcertainfoldersfrombeingsynced">How do I prevent certain folders from being synced?</h3>
202 83dfc24c John
 <p>
203 83dfc24c John
 Use the folderfilter option.
204 83dfc24c John
 </p>
205 83dfc24c John
 <h3 id="Whatisthemailboxnamerecordermbnamesfor">What is the mailbox name recorder (mbnames) for?</h3>
206 83dfc24c John
 <p>
207 83dfc24c John
 Some mail readers, such as mutt, are not capable of automatically determining the names of your mailboxes.  OfflineIMAP can help these programs by writing the names of the folders in a format you specify.  See the example offlineimap.conf for details.
208 83dfc24c John
 </p>
209 83dfc24c John
 <h2 id="IMAPServerNotes">IMAP Server Notes</h2>
210 83dfc24c John
 <p>
211 83dfc24c John
 In general, OfflineIMAP works with any IMAP server that provides compatibility with the IMAP RFCs.  Some servers provide imperfect compatibility that may be good enough for general clients.  OfflineIMAP needs more features, specifically support for UIDs, in order to do its job accurately and completely.
212 83dfc24c John
 </p>
213 83dfc24c John
 <h3 id="MicrosoftExchange">Microsoft Exchange</h3>
214 83dfc24c John
 <p>
215 83dfc24c John
 Several users have reported problems with Microsoft Exchange servers in conjunction with OfflineIMAP. This generally seems to be related to the Exchange servers not properly following the IMAP standards.
216 83dfc24c John
 </p>
217 83dfc24c John
 <p>
218 83dfc24c John
 Mark Biggers has posted some <a class="ext-link" href="http://lists.complete.org/offlineimap@complete.org/2005/09/msg00011.html.gz"><span class="icon">information</span></a> to the OfflineIMAP mailing list about how he made it work.
219 83dfc24c John
 </p>
220 83dfc24c John
 <p>
221 83dfc24c John
 Other users have indicated that older (5.5) releases of Exchange are so bad that they will likely not work at all.
222 83dfc24c John
 </p>
223 83dfc24c John
 <p>
224 83dfc24c John
 I do not have access to Exchange servers for testing, so any problems with it, if they can even be solved at all, will require help from OfflineIMAP users to find and fix.
225 83dfc24c John
 </p>
226 83dfc24c John
 <h2 id="ClientNotes">Client Notes</h2>
227 83dfc24c John
 <h3 id="WhatclientsdoesOfflineIMAPworkwith">What clients does OfflineIMAP work with?</h3>
228 83dfc24c John
 <p>
229 83dfc24c John
 Any client that supports Maildir.  Popular ones include mutt, Evolution, Thunderbird, and KMail.
230 83dfc24c John
 </p>
231 83dfc24c John
 <p>
232 83dfc24c John
 With OfflineIMAP's IMAP-to-IMAP syncing, this can be even wider; see the next question.
233 83dfc24c John
 </p>
234 83dfc24c John
 <h3 id="Evolution">Evolution</h3>
235 83dfc24c John
 <p>
236 83dfc24c John
 OfflineIMAP can work with Evolution. To do so, first configure your OfflineIMAP account to have <tt>sep = /</tt> in its configuration. Then, configure Evolution with the "Maildir-format mail directories" server type. For the path, you will need to specify the name of the top-level folder <i>inside</i> your OfflineIMAP storage location. You're now set!
237 83dfc24c John
 </p>
238 83dfc24c John
 <h3 id="KMail">KMail</h3>
239 83dfc24c John
 <p>
240 83dfc24c John
 At this time, I believe that OfflineIMAP with Maildirs is not compatible with KMail. KMail cannot work in any mode other than to move all messages out of all folders immediately, which (besides being annoying and fundamentally broken) is incompatible with OfflineIMAP.
241 83dfc24c John
 </p>
242 83dfc24c John
 <p>
243 83dfc24c John
 However, I have made KMail version 3 work well with OfflineIMAP by installing an IMAP server on my local machine, having OfflineIMAP sync to that, and pointing KMail at the same server.
244 83dfc24c John
 </p>
245 83dfc24c John
 <h3 id="Mutt">Mutt</h3>
246 83dfc24c John
 <h4 id="DoIneedtousesetmaildir_trash">Do I need to use set maildir_trash?</h4>
247 83dfc24c John
 <p>
248 83dfc24c John
 Other IMAP sync programs require you to do this.  OfflineIMAP does not.  You'll get the best results without it, in fact, though turning it on won't hurt anything.
249 83dfc24c John
 </p>
250 83dfc24c John
 <h4 id="HowdoIsetupmbnameswithmutt">How do I set up mbnames with mutt?</h4>
251 83dfc24c John
 <p>
252 83dfc24c John
 The example offlineimap.c