]> code.delx.au - offlineimap/blobdiff - manual.html
Update changelog
[offlineimap] / manual.html
index 5da8b033fd7cf8b59f686dfec017d2f827358e8c..b77f330ad38140beda60508254253e0d30be4ce0 100644 (file)
@@ -1,11 +1,11 @@
-<!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"
@@ -47,7 +47,7 @@ NAME="AEN3"
 ><DIV
 CLASS="REFNAMEDIV"
 ><A
-NAME="AEN15"
+NAME="AEN14"
 ></A
 ><H2
 >Name</H2
@@ -56,7 +56,7 @@ NAME="AEN15"
 ><DIV
 CLASS="REFSYNOPSISDIV"
 ><A
-NAME="AEN18"
+NAME="AEN17"
 ></A
 ><H2
 >Synopsis</H2
@@ -64,24 +64,36 @@ NAME="AEN18"
 ><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
@@ -92,7 +104,7 @@ CLASS="COMMAND"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN40"
+NAME="AEN39"
 ></A
 ><H2
 >Description</H2
@@ -189,7 +201,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN58"
+NAME="AEN57"
 ></A
 ><H3
 >Method of Operation</H3
@@ -238,7 +250,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN67"
+NAME="AEN66"
 ></A
 ><H2
 >Quick Start</H2
@@ -343,7 +355,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN89"
+NAME="AEN88"
 ></A
 ><H2
 >Installation</H2
@@ -359,7 +371,7 @@ CLASS="APPLICATION"
 >OfflineIMAP</SPAN
 > from
        <A
-HREF="http://quux.org/devel/offlineimap/"
+HREF="http://software.complete.org/offlineimap/"
 TARGET="_top"
 >the <SPAN
 CLASS="APPLICATION"
@@ -371,7 +383,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN95"
+NAME="AEN94"
 ></A
 ><H3
 >Prerequisites</H3
@@ -435,7 +447,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN109"
+NAME="AEN108"
 ></A
 ><H3
 >System-Wide Installation, Debian</H3
@@ -455,7 +467,7 @@ CLASS="COMMAND"
 ><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"
@@ -481,14 +493,14 @@ CLASS="COMMAND"
 ><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
 >.
@@ -524,14 +536,14 @@ CLASS="COMMAND"
 ><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
 >.
@@ -609,7 +621,7 @@ CLASS="FILENAME"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN152"
+NAME="AEN151"
 ></A
 ><H2
 >Options</H2
@@ -645,9 +657,11 @@ CLASS="PROPERTY"
          </P
 ></DD
 ><DT
->-P <VAR
+>-P <TT
 CLASS="REPLACEABLE"
->profiledir</VAR
+><I
+>profiledir</I
+></TT
 ></DT
 ><DD
 ><P
@@ -655,9 +669,11 @@ CLASS="REPLACEABLE"
 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
@@ -665,20 +681,22 @@ CLASS="REPLACEABLE"
            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
@@ -696,9 +714,11 @@ CLASS="PROPERTY"
          </P
 ></DD
 ><DT
->-c <VAR
+>-c <TT
 CLASS="REPLACEABLE"
->configfile</VAR
+><I
+>configfile</I
+></TT
 ></DT
 ><DD
 ><P
@@ -710,23 +730,25 @@ CLASS="FILENAME"
          </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
@@ -760,9 +782,11 @@ CLASS="PROPERTY"
 ></DD
 ><DT
 >-l
-         <VAR
+         <TT
 CLASS="REPLACEABLE"
->filename</VAR
+><I
+>filename</I
+></TT
 ></DT
 ><DD
 ><P
@@ -790,9 +814,11 @@ CLASS="PROPERTY"
 >Show summary of options.</P
 ></DD
 ><DT
->-u <VAR
+>-u <TT
 CLASS="REPLACEABLE"
->interface</VAR
+><I
+>interface</I
+></TT
 ></DT
 ><DD
 ><P
@@ -807,7 +833,7 @@ CLASS="REPLACEABLE"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN219"
+NAME="AEN218"
 ></A
 ><H2
 >User Interfaces</H2
@@ -823,9 +849,9 @@ CLASS="APPLICATION"
 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
@@ -833,7 +859,7 @@ CLASS="OPTION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN225"
+NAME="AEN224"
 ></A
 ><H3
 >Tk.Blinkenlights</H3
@@ -989,7 +1015,7 @@ CLASS="FIRSTTERM"
 >, in part, as:
        </P
 ><A
-NAME="AEN288"
+NAME="AEN287"
 ></A
 ><BLOCKQUOTE
 CLASS="BLOCKQUOTE"
@@ -1026,7 +1052,7 @@ CLASS="EMPHASIS"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN294"
+NAME="AEN293"
 ></A
 ><H3
 >Curses.Blinkenlights</H3
@@ -1044,7 +1070,7 @@ NAME="AEN294"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN298"
+NAME="AEN297"
 ></A
 ><H3
 >Tk.VerboseUI</H3
@@ -1061,7 +1087,7 @@ NAME="AEN298"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN301"
+NAME="AEN300"
 ></A
 ><H3
 >TTY.TTYUI</H3
@@ -1074,7 +1100,7 @@ NAME="AEN301"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN304"
+NAME="AEN303"
 ></A
 ><H3
 >Noninteractive.Basic</H3
@@ -1094,7 +1120,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN308"
+NAME="AEN307"
 ></A
 ><H3
 >Noninteractive.Quiet</H3
@@ -1111,7 +1137,7 @@ NAME="AEN308"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN311"
+NAME="AEN310"
 ></A
 ><H2
 >Examples</H2
@@ -1123,7 +1149,7 @@ NAME="AEN311"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN314"
+NAME="AEN313"
 ></A
 ><H3
 >Multiple Accounts with Mutt</H3
@@ -1196,7 +1222,7 @@ spoolfile=+Personal/INBOX</PRE
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN333"
+NAME="AEN332"
 ></A
 ><H3
 >UW-IMAPD and References</H3
@@ -1255,7 +1281,7 @@ holdconnectionopen = no</PRE
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN341"
+NAME="AEN340"
 ></A
 ><H3
 >pythonfile Configuration File Option</H3
@@ -1325,7 +1351,7 @@ CLASS="PROPERTY"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN354"
+NAME="AEN353"
 ></A
 ><H2
 >Errors</H2
@@ -1336,7 +1362,7 @@ NAME="AEN354"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN357"
+NAME="AEN356"
 ></A
 ><H3
 >UID validity problem for folder</H3
@@ -1383,13 +1409,17 @@ CLASS="FILENAME"
 ><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 
@@ -1445,11 +1475,48 @@ TARGET="_top"
 > of the problem there.
        </P
 ></DIV
+><DIV
+CLASS="REFSECT2"
+><A
+NAME="AEN381"
+></A
+><H3
+>Use with MS Exchange server</H3
+><P
+>          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.
+        </P
+><P
+>          Mark Biggers has posted some <A
+HREF="http://lists.complete.org/offlineimap@complete.org/2005/09/msg00011.html.gz"
+TARGET="_top"
+>information</A
+>
+          to the <SPAN
+CLASS="APPLICATION"
+>OfflineIMAP</SPAN
+> mailing list about how he made it work.
+        </P
+><P
+>          Other users have indicated that older (5.5) releases of
+          Exchange are so bad that they will likely not work at all.
+        </P
+><P
+>          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 <SPAN
+CLASS="APPLICATION"
+>OfflineIMAP</SPAN
+> users to find and fix.
+        </P
+></DIV
 ></DIV
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN382"
+NAME="AEN390"
 ></A
 ><H2
 >Other Frequently Asked Questions</H2
@@ -1517,7 +1584,7 @@ CLASS="PROPERTY"
 >folderfilter</SPAN
 > and <SPAN
 CLASS="PROPERTY"
->foldertrans</SPAN
+>nametrans</SPAN
 >
            configuration file options to request certain folders and rename them
            as they come in if you like.
@@ -1788,7 +1855,7 @@ CLASS="PROGRAMLISTING"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN500"
+NAME="AEN508"
 ></A
 ><H2
 >Conforming To</H2
@@ -1827,14 +1894,14 @@ TARGET="_top"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN513"
+NAME="AEN521"
 ></A
 ><H2
 >Notes</H2
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN515"
+NAME="AEN523"
 ></A
 ><H3
 >Deleting Local Folders</H3
@@ -1866,7 +1933,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN522"
+NAME="AEN530"
 ></A
 ><H3
 >Multiple Instances</H3
@@ -1895,7 +1962,7 @@ CLASS="PROPERTY"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN529"
+NAME="AEN537"
 ></A
 ><H3
 >Copying Messages Between Folders</H3
@@ -1925,7 +1992,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN535"
+NAME="AEN543"
 ></A
 ><H3
 >Use with Evolution</H3
@@ -1938,9 +2005,9 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >OfflineIMAP</SPAN
 > account to have
-         <VAR
+         <CODE
 CLASS="OPTION"
->sep = /</VAR
+>sep = /</CODE
 > in its configuration.  Then, configure
          Evolution with the
          "Maildir-format mail directories" server type.  For the path, you will need to
@@ -1961,7 +2028,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN543"
+NAME="AEN551"
 ></A
 ><H3
 >Use with KMail</H3
@@ -1995,7 +2062,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN551"
+NAME="AEN559"
 ></A
 ><H3
 >Mailing List</H3
@@ -2014,7 +2081,7 @@ TARGET="_top"
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN555"
+NAME="AEN563"
 ></A
 ><H3
 >Bugs</H3
@@ -2023,17 +2090,10 @@ NAME="AEN555"
          <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.
+> mailing list at offlineimap at complete
+          dot org.  Debian users are encouraged to instead use the
+       Debian
+          bug-tracking system.
        </P
 ></DIV
 ></DIV
@@ -2103,7 +2163,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN575"
+NAME="AEN581"
 ></A
 ><H2
 >Copyright</H2
@@ -2141,7 +2201,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN584"
+NAME="AEN590"
 ></A
 ><H2
 >Author</H2
@@ -2164,15 +2224,10 @@ HREF="mailto:jgoerzen@complete.org"
 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"
+       <A
+HREF="http://software.complete.org/offlineimap"
 TARGET="_top"
->HTTP</A
+>homepage</A
 >.
       </P
 ><P
@@ -2193,7 +2248,7 @@ TARGET="_top"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN596"
+NAME="AEN601"
 ></A
 ><H2
 >See Also</H2
@@ -2211,7 +2266,7 @@ CLASS="APPLICATION"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN601"
+NAME="AEN606"
 ></A
 ><H2
 >History</H2