-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>OfflineIMAP Manual</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
><BODY
CLASS="REFERENCE"
BGCOLOR="#FFFFFF"
><DIV
CLASS="REFNAMEDIV"
><A
-NAME="AEN15"
+NAME="AEN14"
></A
><H2
>Name</H2
><DIV
CLASS="REFSYNOPSISDIV"
><A
-NAME="AEN18"
+NAME="AEN17"
></A
><H2
>Synopsis</H2
><B
CLASS="COMMAND"
>offlineimap</B
-> [-1] [-P <VAR
+> [-1] [-P <TT
CLASS="REPLACEABLE"
->profiledir</VAR
->] [-a <VAR
+><I
+>profiledir</I
+></TT
+>] [-a <TT
CLASS="REPLACEABLE"
->accountlist</VAR
->] [-c <VAR
+><I
+>accountlist</I
+></TT
+>] [-c <TT
CLASS="REPLACEABLE"
->configfile</VAR
->] [-d <VAR
+><I
+>configfile</I
+></TT
+>] [-d <TT
CLASS="REPLACEABLE"
->debugtype[,...]</VAR
->] [-l <VAR
+><I
+>debugtype[,...]</I
+></TT
+>] [-l <TT
CLASS="REPLACEABLE"
->filename</VAR
->] [-o] [-u <VAR
+><I
+>filename</I
+></TT
+>] [-o] [-u <TT
CLASS="REPLACEABLE"
->interface</VAR
+><I
+>interface</I
+></TT
>]</P
><P
><B
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN40"
+NAME="AEN39"
></A
><H2
>Description</H2
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN58"
+NAME="AEN57"
></A
><H3
>Method of Operation</H3
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN67"
+NAME="AEN66"
></A
><H2
>Quick Start</H2
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN89"
+NAME="AEN88"
></A
><H2
>Installation</H2
>OfflineIMAP</SPAN
> from
<A
-HREF="http://quux.org/devel/offlineimap/"
+HREF="http://software.complete.org/offlineimap/"
TARGET="_top"
>the <SPAN
CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN95"
+NAME="AEN94"
></A
><H3
>Prerequisites</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN109"
+NAME="AEN108"
></A
><H3
>System-Wide Installation, Debian</H3
><P
> If you are not tracking Debian unstable, download the Debian .deb
package from the <A
-HREF="http://quux.org/devel/offlineimap/"
+HREF="http://software.complete.org/offlineimap/"
TARGET="_top"
><SPAN
CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN121"
+NAME="AEN120"
></A
><H3
>System-Wide Installation, Other</H3
><P
> Download the tar.gz version of the package from the
<A
-HREF="http://quux.org/devel/offlineimap/"
+HREF="http://software.complete.org/offlineimap/"
TARGET="_top"
>website</A
>.
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN131"
+NAME="AEN130"
></A
><H3
>Single-Account Installation</H3
><P
> Download the tar.gz version of the package from the
<A
-HREF="http://quux.org/devel/offlineimap/"
+HREF="http://software.complete.org/offlineimap/"
TARGET="_top"
>website</A
>.
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN152"
+NAME="AEN151"
></A
><H2
>Options</H2
</P
></DD
><DT
->-P <VAR
+>-P <TT
CLASS="REPLACEABLE"
->profiledir</VAR
+><I
+>profiledir</I
+></TT
></DT
><DD
><P
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> into profile mode. The program
- will create <VAR
+ will create <TT
CLASS="REPLACEABLE"
->profiledir</VAR
+><I
+>profiledir</I
+></TT
>
(it must not already exist). As it runs, Python profiling
information
is present for debugging and optimization only, and should NOT be used
unless you have a specific reason to do so. It will significantly
slow program performance, may reduce reliability, and can generate
- huge amounts of data. You must use the <VAR
+ huge amounts of data. You must use the <CODE
CLASS="OPTION"
->-1</VAR
+>-1</CODE
> option when
- you use <VAR
+ you use <CODE
CLASS="OPTION"
->-P</VAR
+>-P</CODE
>.
</P
></DD
><DT
->-a <VAR
+>-a <TT
CLASS="REPLACEABLE"
->accountlist</VAR
+><I
+>accountlist</I
+></TT
></DT
><DD
><P
</P
></DD
><DT
->-c <VAR
+>-c <TT
CLASS="REPLACEABLE"
->configfile</VAR
+><I
+>configfile</I
+></TT
></DT
><DD
><P
</P
></DD
><DT
->-d <VAR
+>-d <TT
CLASS="REPLACEABLE"
->debugtype[,...]</VAR
+><I
+>debugtype[,...]</I
+></TT
></DT
><DD
><P
>Enables debugging for OfflineIMAP. This is useful if
you are trying to track down a malfunction or figure out what is going
on under the hood. I suggest that you use this with
- <VAR
+ <CODE
CLASS="OPTION"
->-1</VAR
+>-1</CODE
> to make the results more sensible.</P
><P
-><VAR
+><CODE
CLASS="OPTION"
->-d</VAR
+>-d</CODE
> requires one or more debugtypes,
separated by commas. These define what exactly will be
debugged, and include three options: <SPAN
></DD
><DT
>-l
- <VAR
+ <TT
CLASS="REPLACEABLE"
->filename</VAR
+><I
+>filename</I
+></TT
></DT
><DD
><P
>Show summary of options.</P
></DD
><DT
->-u <VAR
+>-u <TT
CLASS="REPLACEABLE"
->interface</VAR
+><I
+>interface</I
+></TT
></DT
><DD
><P
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN219"
+NAME="AEN218"
></A
><H2
>User Interfaces</H2
CLASS="PROPERTY"
>ui</SPAN
> option in the configuration file specifies
- user interface preferences. The <VAR
+ user interface preferences. The <CODE
CLASS="OPTION"
->-u</VAR
+>-u</CODE
> command-line
option can override the configuration file setting. The available
values for the configuration file or command-line are described
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN225"
+NAME="AEN224"
></A
><H3
>Tk.Blinkenlights</H3
>, in part, as:
</P
><A
-NAME="AEN288"
+NAME="AEN287"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN294"
+NAME="AEN293"
></A
><H3
>Curses.Blinkenlights</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN298"
+NAME="AEN297"
></A
><H3
>Tk.VerboseUI</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN301"
+NAME="AEN300"
></A
><H3
>TTY.TTYUI</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN304"
+NAME="AEN303"
></A
><H3
>Noninteractive.Basic</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN308"
+NAME="AEN307"
></A
><H3
>Noninteractive.Quiet</H3
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN311"
+NAME="AEN310"
></A
><H2
>Examples</H2
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN314"
+NAME="AEN313"
></A
><H3
>Multiple Accounts with Mutt</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN333"
+NAME="AEN332"
></A
><H3
>UW-IMAPD and References</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN341"
+NAME="AEN340"
></A
><H3
>pythonfile Configuration File Option</H3
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN354"
+NAME="AEN353"
></A
><H2
>Errors</H2
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN357"
+NAME="AEN356"
></A
><H3
>UID validity problem for folder</H3
><PRE
CLASS="PROGRAMLISTING"
>rm -r ~/Folders/INBOX
-rm -r ~/.offlineimap/Account-<VAR
+rm -r ~/.offlineimap/Account-<TT
CLASS="REPLACEABLE"
->AccountName</VAR
+><I
+>AccountName</I
+></TT
>
-rm -r ~/.offlineimap/Repository-<VAR
+rm -r ~/.offlineimap/Repository-<TT
CLASS="REPLACEABLE"
->RepositoryName</VAR
+><I
+>RepositoryName</I
+></TT
></PRE
><P
> (Of course, replace AccountName and RepositoryName
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN382"
-></A
-><H2
->Other Frequently Asked Questions</H2
-><P
->There are some other FAQs that might not fit into another section
- of the document, so they are discussed here.
- </P
-><P
-></P
-><DIV
-CLASS="VARIABLELIST"
-><DL
-><DT
->What platforms does <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> run on?</DT
-><DD
-><P
-> 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; see the FAQ entry for that platform.
- </P
-></DD
-><DT
->I'm using Mutt. Other IMAP sync programs require me to use "set maildir_trash=yes". Do I need to do that with <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->?</DT
-><DD
-><P
-> No. <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> is smart enough to figure out message deletion without this extra
- crutch. You'll get the best results if you don't use this setting, in
- fact.
- </P
-></DD
-><DT
->I've upgraded and now <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->
- crashes when I start it up! Why?</DT
-><DD
-><P
->You need to upgrade your configuration
- file. See at the end of this
- manual.
- </P
-></DD
-><DT
->How do I specify the names of my folders?</DT
-><DD
-><P
-> You do not need to. <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> is smart
- enough to automatically figure out what folders are present
- on the IMAP server and synchronize them. You can use the
- <SPAN
-CLASS="PROPERTY"
->folderfilter</SPAN
-> and <SPAN
-CLASS="PROPERTY"
->foldertrans</SPAN
->
- configuration file options to request certain folders and rename them
- as they come in if you like.
- </P
-></DD
-><DT
->How can I prevent certain folders from being synced?</DT
-><DD
-><P
-> Use the <SPAN
-CLASS="PROPERTY"
->folderfilter</SPAN
-> option in the configuration file.
- </P
-></DD
-><DT
->How can I add or delete a folder?</DT
-><DD
-><P
-> <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> does not currently provide this feature, but if you create a new
- folder on the IMAP server, it will be created locally automatically.
- </P
-></DD
-><DT
->Are there any other warnings that I should be aware of?</DT
-><DD
-><P
-> Yes; see the Notes section below.
- </P
-></DD
-><DT
->What is the mailbox name recorder (mbnames) for?</DT
-><DD
-><P
->Some mail readers, such as Mutt, are not capable
- of automatically determining the names of your mailboxes.
- <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> can help these programs by writing the names
- of the folders in a format you specify. See the example
- <TT
-CLASS="FILENAME"
->offlineimap.conf</TT
-> for details.
- </P
-></DD
-><DT
->Can I synchronize multiple accounts with <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->?</DT
-><DD
-><P
->Sure. Just name them all in the
- <SPAN
-CLASS="PROPERTY"
->accounts</SPAN
-> line in the <SPAN
-CLASS="PROPERTY"
->general</SPAN
->
- section of the configuration file, and add a per-account section
- for each one.
- </P
-></DD
-><DT
->Does <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> support POP?</DT
-><DD
-><P
->No. POP is not robust enough to do a completely reliable
- multi-machine synchronization like <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> can do. <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->
- will not support it.
- </P
-></DD
-><DT
->Does <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> support mailbox formats other than Maildir?</DT
-><DD
-><P
->Not at present. There is no technical reason not to; just no
- demand yet. Maildir is a superior format anyway.
- However, <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> can sync between two IMAP
- servers, and some IMAP servers support other formats. You
- could install an IMAP server on your local machine and have
- <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> sync to that.
- </P
-></DD
-><DT
->[technical] Why are your Maildir message filenames so huge?</DT
-><DD
-><P
-><SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> has two relevant principles: 1) never modifying your
- messages in any way and 2) ensuring 100% reliable synchronizations.
- In order to do a reliable sync, <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->
- must have a way to
- uniquely identify each e-mail. Three pieces of information are
- required to do this: your account name, the folder name, and the
- message UID. The account name can be calculated from the path in
- which your messages are. The folder name can usually be as well, BUT
- some mail clients move messages between folders by simply moving the
- file, leaving the name intact.
- </P
-><P
-> So, <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> must store both a UID folder ID. The folder ID is
- necessary so <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> can detect a message moved to a different
- folder. <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> stores the UID (U= number) and an md5sum of the
- foldername (FMD5= number) to facilitate this.
- </P
-></DD
-><DT
->What is the speed of <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->'s sync?</DT
-><DD
-><P
->OfflineIMAP
- versions 2.0 and above contain a multithreaded system. A good way to
- experiment is by setting <SPAN
-CLASS="PROPERTY"
->maxsyncaccounts</SPAN
-> to 3 and <SPAN
-CLASS="PROPERTY"
->maxconnections</SPAN
-> to 3
- in each account clause.
- </P
-><P
->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.
- </P
-><P
->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.
- </P
-><P
->An informal benchmark yields these results for my setup:
- </P
-><P
-></P
-><UL
-><LI
-><P
->10 minutes with MacOS X Mail.app "manual cache"
- </P
-></LI
-><LI
-><P
->5 minutes with GNUS agent sync</P
-></LI
-><LI
-><P
->20 seconds with OfflineIMAP 1.x</P
-></LI
-><LI
-><P
->9 seconds with OfflineIMAP 2.x</P
-></LI
-><LI
-><P
->3 seconds with OfflineIMAP 3.x "cold start"</P
-></LI
-><LI
-><P
->2 seconds with OfflineIMAP 3.x "held connection"</P
-></LI
-></UL
-></DD
-><DT
->Can I use <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> on Windows?</DT
-><DD
-><P
-> These answers have been reported by <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->
- users. I do not run <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> on Windows myself, so
- I can't directly address their accuracy.
- </P
-><P
-> The basic answer is that it's possible and doesn't
- require hacking <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> source code. However,
- it's not necessarily trivial. The information below is
- based in instructions submitted by Chris Walker.
- </P
-><P
-> First, you must run <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> in the <A
-HREF="http://www.cygwin.com/"
-TARGET="_top"
->Cygwin</A
->
- environment.
- </P
-><P
-> Next, you'll need to mount your Maildir directory in a
- special way. There is information for doing that at
- <A
-HREF="http://barnson.org/node/view/295"
-TARGET="_top"
->http://barnson.org/node/view/295</A
->.
- That site gives this example:
- </P
-><PRE
-CLASS="PROGRAMLISTING"
->mount -f -s -b -o managed "d:/tmp/mail" "/home/of/mail"
- </PRE
-><P
-> That URL also has more details on making OfflineIMAP
- work with Windows.
- </P
-></DD
-></DL
-></DIV
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN500"
+NAME="AEN381"
></A
><H2
>Conforming To</H2
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN513"
+NAME="AEN394"
></A
><H2
>Notes</H2
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN515"
+NAME="AEN396"
></A
><H3
>Deleting Local Folders</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN522"
+NAME="AEN403"
></A
><H3
>Multiple Instances</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN529"
+NAME="AEN410"
></A
><H3
>Copying Messages Between Folders</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN535"
-></A
-><H3
->Use with Evolution</H3
-><P
-><SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> can work with Evolution. To do so, first configure
- your <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> account to have
- <VAR
-CLASS="OPTION"
->sep = /</VAR
-> 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
- <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->inside</I
-></SPAN
-> your <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> storage location.
- You're now set!
- </P
-></DIV
-><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN543"
-></A
-><H3
->Use with KMail</H3
-><P
->At this time, I believe that <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> 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
- <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
->.
- </P
-><P
-> However, I have made KMail version 3 work well with
- <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> by installing an IMAP server on my local
- machine, having <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> sync to that, and pointing
- KMail at the same server.
- </P
-></DIV
-><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN551"
+NAME="AEN416"
></A
><H3
>Mailing List</H3
><DIV
CLASS="REFSECT2"
><A
-NAME="AEN555"
+NAME="AEN420"
></A
><H3
>Bugs</H3
><P
->Reports of bugs should be sent via e-mail to the
- <SPAN
+> Reports of bugs should be reported online at the
+ <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
-> bug-tracking system (BTS) at
- offlineimap@bugs.complete.org or submitted online using
- the <A
-HREF="http://bugs.complete.org/"
-TARGET="_top"
->web interface</A
->.
- </P
-><P
-> The Web site also lists all current bugs, where you can check their
- status or contribute to fixing them.
+> homepage.
+ Debian users are encouraged to instead use the
+ Debian
+ bug-tracking system.
</P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN575"
+NAME="AEN438"
></A
><H2
>Copyright</H2
><P
->OfflineIMAP, and this manual, are Copyright © 2002, 2003 John Goerzen.</P
+>OfflineIMAP, and this manual, are Copyright © 2002 - 2006 John Goerzen.</P
><P
> This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN584"
+NAME="AEN447"
></A
><H2
>Author</H2
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> may be downloaded, and information found, from its
- homepage via either <A
-HREF="gopher://quux.org/1/devel/offlineimap"
-TARGET="_top"
->Gopher</A
->
- or <A
-HREF="http://quux.org/devel/offlineimap"
-TARGET="_top"
->HTTP</A
->.
- </P
-><P
-> <SPAN
-CLASS="APPLICATION"
->OfflineIMAP</SPAN
-> may also be downloaded using Subversion. Additionally,
- the distributed tar.gz may be updated with a simple "svn update"
- command; it is ready to go. For information on getting OfflineIMAP
- with Subversion, please visit the
<A
-HREF="http://svn.complete.org/"
+HREF="http://software.complete.org/offlineimap"
TARGET="_top"
->complete.org Subversion page</A
+>homepage</A
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN596"
+NAME="AEN455"
></A
><H2
>See Also</H2
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN601"
+NAME="AEN460"
></A
><H2
>History</H2