tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

/offlineimap/head: changeset 449

Browse Source 
- Slight renaming in offlineimap.conf.minimal to clarify things.

- Documentation updated with information about new features. Closes:
  #189771. + Described IMAP-IMAP syncing + Updated minimal example
  with new offlineimap.conf.minimal + Updated UID information. Added
  link to recent mailing list discussion. + Described KMail syncing,
  which now works. + Added link to mailing list archives.
This commit is contained in:
jgoerzen 2003-04-22 21:47:25 +01:00
parent 0373766d70
commit 0db32b6393
8 changed files with 1447 additions and 1067 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
offlineimap/head/debian/changelog
View File

@ -4,6 +4,15 @@ offlineimap (3.99.14) unstable; urgency=low
".". Useful for generating Maildir trees for a Courier server. ".". Useful for generating Maildir trees for a Courier server.
* Fixed the regular expression that fixes line endings to make sure to * Fixed the regular expression that fixes line endings to make sure to
deal with \n\n properly. deal with \n\n properly.
* Slight renaming in offlineimap.conf.minimal to clarify things.
* Documentation updated with information about new features.
Closes: #189771.
+ Described IMAP-IMAP syncing
+ Updated minimal example with new offlineimap.conf.minimal
+ Updated UID information. Added link to recent mailing list
discussion.
+ Described KMail syncing, which now works.
+ Added link to mailing list archives.
-- John Goerzen <jgoerzen@complete.org> Thu, 17 Apr 2003 21:13:27 -0500 -- John Goerzen <jgoerzen@complete.org> Thu, 17 Apr 2003 21:13:27 -0500

247
offlineimap/head/manual.html
View File

@ -204,7 +204,8 @@ NAME="AEN56"
><SPAN ><SPAN
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
> operates by maintaining a hierarchy of > traditionally
operates by maintaining a hierarchy of
mail folders in Maildir format locally. Your own mail mail folders in Maildir format locally. Your own mail
reader will read mail from this tree, and need never know reader will read mail from this tree, and need never know
that the mail comes from IMAP. <SPAN that the mail comes from IMAP. <SPAN
@ -215,12 +216,34 @@ CLASS="APPLICATION"
computer and bi-directionally synchronize them, copying, computer and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary. marking, and deleting messages as necessary.
</P </P
><P
> With <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> 4.0, a powerful new ability has been
introduced -- the program can now synchronize two IMAP
servers with each other, with no need to have a Maildir
layer in-between. Many people use this if they use a mail
reader on their local machine that does not support
Maildirs. People may install an IMAP server on their local
machine, and point both <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> and their mail reader
of choice at it. This is often preferable to the mail
reader's own IMAP support since <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> supports many
features (offline reading, for one) that most IMAP-aware
readers don't.
</P
></DIV ></DIV
></DIV ></DIV
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN61" NAME="AEN65"
></A ></A
><H2 ><H2
>Quick Start</H2 >Quick Start</H2
@ -271,8 +294,16 @@ CLASS="PROGRAMLISTING"
>[general] >[general]
accounts = Test accounts = Test
[Test] [Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost remotehost = examplehost
remoteuser = jgoerzen</PRE remoteuser = jgoerzen</PRE
><P ><P
@ -317,7 +348,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN83" NAME="AEN87"
></A ></A
><H2 ><H2
>Installation</H2 >Installation</H2
@ -345,7 +376,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN89" NAME="AEN93"
></A ></A
><H3 ><H3
>Prerequisites</H3 >Prerequisites</H3
@ -387,22 +418,29 @@ TARGET="_top"
></LI ></LI
><LI ><LI
><P ><P
> Have a mail reader that supports the Maildir mailbox format. Most > Have a mail reader that supports the Maildir mailbox
modern mail readers have this support built-in, so you can choose from format. Most modern mail readers have this support
a wide variety of mail servers. This format is also known as the built-in, so you can choose from a wide variety of mail
"qmail" format, so any mail reader compatible with it will work with servers. This format is also known as the "qmail"
<SPAN format, so any mail reader compatible with it will work
with <SPAN
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
>. >. If you do not have a mail reader
</P that supports Maildir, you can often install a local
IMAP server and point both <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> and your mail
reader at it.
</P
></LI ></LI
></UL ></UL
></DIV ></DIV
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN102" NAME="AEN107"
></A ></A
><H3 ><H3
>System-Wide Installation, Debian</H3 >System-Wide Installation, Debian</H3
@ -448,7 +486,7 @@ CLASS="COMMAND"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN114" NAME="AEN119"
></A ></A
><H3 ><H3
>System-Wide Installation, Other</H3 >System-Wide Installation, Other</H3
@ -491,7 +529,7 @@ CLASS="COMMAND"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN124" NAME="AEN129"
></A ></A
><H3 ><H3
>Single-Account Installation</H3 >Single-Account Installation</H3
@ -576,7 +614,7 @@ CLASS="FILENAME"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN145" NAME="AEN150"
></A ></A
><H2 ><H2
>Options</H2 >Options</H2
@ -599,7 +637,8 @@ CLASS="VARIABLELIST"
><P ><P
>Disable most multithreading operations and use >Disable most multithreading operations and use
solely a single-connection solely a single-connection
sync. This effectively sets the <SPAN sync. This effectively sets the
<SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>maxsyncaccounts</SPAN >maxsyncaccounts</SPAN
> >
@ -705,14 +744,18 @@ CLASS="OPTION"
>-d</TT >-d</TT
> requires one or more debugtypes, > requires one or more debugtypes,
separated by commas. These define what exactly will be separated by commas. These define what exactly will be
debugged, and include two options: <SPAN debugged, and include three options: <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>imap</SPAN >imap</SPAN
> >,
and <SPAN <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>maildir</SPAN >maildir</SPAN
>. The <SPAN >, and <SPAN
CLASS="PROPERTY"
>thread</SPAN
>.
The <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>imap</SPAN >imap</SPAN
> >
@ -723,7 +766,11 @@ CLASS="PROPERTY"
CLASS="PROPERTY" CLASS="PROPERTY"
>maildir</SPAN >maildir</SPAN
> option will enable debugging for > option will enable debugging for
certain Maildir operations. certain Maildir operations. And <SPAN
CLASS="PROPERTY"
>thread</SPAN
>
will debug the threading model.
</P </P
></DD ></DD
><DT ><DT
@ -763,7 +810,7 @@ CLASS="REPLACEABLE"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN205" NAME="AEN212"
></A ></A
><H2 ><H2
>User Interfaces</H2 >User Interfaces</H2
@ -789,7 +836,7 @@ CLASS="OPTION"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN211" NAME="AEN218"
></A ></A
><H3 ><H3
>Tk.Blinkenlights</H3 >Tk.Blinkenlights</H3
@ -945,7 +992,7 @@ CLASS="FIRSTTERM"
>, in part, as: >, in part, as:
</P </P
><A ><A
NAME="AEN274" NAME="AEN281"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
@ -982,7 +1029,7 @@ CLASS="EMPHASIS"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN280" NAME="AEN287"
></A ></A
><H3 ><H3
>Curses.Blinkenlights</H3 >Curses.Blinkenlights</H3
@ -1000,7 +1047,7 @@ NAME="AEN280"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN284" NAME="AEN291"
></A ></A
><H3 ><H3
>Tk.VerboseUI</H3 >Tk.VerboseUI</H3
@ -1017,7 +1064,7 @@ NAME="AEN284"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN287" NAME="AEN294"
></A ></A
><H3 ><H3
>TTY.TTYUI</H3 >TTY.TTYUI</H3
@ -1030,7 +1077,7 @@ NAME="AEN287"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN290" NAME="AEN297"
></A ></A
><H3 ><H3
>Noninteractive.Basic</H3 >Noninteractive.Basic</H3
@ -1050,7 +1097,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN294" NAME="AEN301"
></A ></A
><H3 ><H3
>Noninteractive.Quiet</H3 >Noninteractive.Quiet</H3
@ -1067,7 +1114,7 @@ NAME="AEN294"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN297" NAME="AEN304"
></A ></A
><H2 ><H2
>Examples</H2 >Examples</H2
@ -1079,7 +1126,7 @@ NAME="AEN297"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN300" NAME="AEN307"
></A ></A
><H3 ><H3
>Multiple Accounts with Mutt</H3 >Multiple Accounts with Mutt</H3
@ -1105,25 +1152,28 @@ CLASS="FILENAME"
CLASS="PROGRAMLISTING" CLASS="PROGRAMLISTING"
>accounts = Personal, Work</PRE >accounts = Personal, Work</PRE
><P ><P
> Make sure that you have both a <SPAN > Make sure that you have both an
<SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>[Personal]</SPAN >[Account Personal]</SPAN
> >
and a <SPAN and an <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>[Work]</SPAN >[Account Work]</SPAN
> section, each with different > section. The
local repository for each account must have different
<SPAN <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>localfolder</SPAN >localfolder</SPAN
> path names. Also, make sure > path names.
Also, make sure
to enable <SPAN to enable <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>[mbnames]</SPAN >[mbnames]</SPAN
>. >.
</P </P
><P ><P
> In each account section, write something like this: > In each local repository section, write something like this:
</P </P
><PRE ><PRE
CLASS="PROGRAMLISTING" CLASS="PROGRAMLISTING"
@ -1149,7 +1199,7 @@ spoolfile=+Personal/INBOX</PRE
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN319" NAME="AEN326"
></A ></A
><H3 ><H3
>UW-IMAPD and References</H3 >UW-IMAPD and References</H3
@ -1160,7 +1210,7 @@ CLASS="APPLICATION"
>'s >'s
"reference" feature to get at their mailboxes, specifying a reference "reference" feature to get at their mailboxes, specifying a reference
of "~/Mail" or "#mh/" depending on the configuration. The below of "~/Mail" or "#mh/" depending on the configuration. The below
configuration from docwhat@gerf.org configuration from (originally from docwhat@gerf.org)
shows using a <SPAN shows using a <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>reference</SPAN >reference</SPAN
@ -1178,8 +1228,16 @@ CLASS="PROPERTY"
</P </P
><PRE ><PRE
CLASS="PROGRAMLISTING" CLASS="PROGRAMLISTING"
>[Gerf] >[Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org remotehost = gerf.org
ssl = yes ssl = yes
remoteuser = docwhat remoteuser = docwhat
@ -1200,7 +1258,7 @@ holdconnectionopen = no</PRE
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN327" NAME="AEN334"
></A ></A
><H3 ><H3
>pythonfile Configuration File Option</H3 >pythonfile Configuration File Option</H3
@ -1223,7 +1281,7 @@ CLASS="FILENAME"
CLASS="PROGRAMLISTING" CLASS="PROGRAMLISTING"
>[general] >[general]
pythonfile=~/.offlineimap.py pythonfile=~/.offlineimap.py
[foo] [Repository foo]
foldersort=mycmp</PRE foldersort=mycmp</PRE
><P ><P
> Then, the <TT > Then, the <TT
@ -1266,7 +1324,7 @@ CLASS="PROPERTY"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN340" NAME="AEN347"
></A ></A
><H2 ><H2
>Errors</H2 >Errors</H2
@ -1277,7 +1335,7 @@ NAME="AEN340"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN343" NAME="AEN350"
></A ></A
><H3 ><H3
>UID validity problem for folder</H3 >UID validity problem for folder</H3
@ -1324,9 +1382,21 @@ CLASS="FILENAME"
><PRE ><PRE
CLASS="PROGRAMLISTING" CLASS="PROGRAMLISTING"
>rm -r ~/Folders/INBOX >rm -r ~/Folders/INBOX
rm -r ~/.offlineimap/AccountName/INBOX</PRE rm -r ~/.offlineimap/Account-<TT
CLASS="REPLACEABLE"
><I
>AccountName</I
></TT
>
rm -r ~/.offlineimap/Repository-<TT
CLASS="REPLACEABLE"
><I
>RepositoryName</I
></TT
></PRE
><P ><P
> (Of course, replace AccountName with the account name as specified > (Of course, replace AccountName and RepositoryName
with the names as specified
in <TT in <TT
CLASS="FILENAME" CLASS="FILENAME"
>~/.offlineimaprc</TT >~/.offlineimaprc</TT
@ -1359,12 +1429,30 @@ CLASS="APPLICATION"
> will detect > will detect
this condition and abort prior to synchronization.) this condition and abort prior to synchronization.)
</P </P
><P
> This question comes up frequently on the
<A
HREF="http://lists.complete.org/offlineimap@complete.org/"
TARGET="_top"
><SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
>
mailing list</A
>. You can find a
<A
HREF="http://lists.complete.org/offlineimap@complete.org/2003/04/msg00012.html.gz"
TARGET="_top"
>detailed
discussion</A
> of the problem there.
</P
></DIV ></DIV
></DIV ></DIV
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN362" NAME="AEN375"
></A ></A
><H2 ><H2
>Other Frequently Asked Questions</H2 >Other Frequently Asked Questions</H2
@ -1515,6 +1603,16 @@ CLASS="APPLICATION"
><P ><P
>Not at present. There is no technical reason not to; just no >Not at present. There is no technical reason not to; just no
demand yet. Maildir is a superior format anyway. 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 </P
></DD ></DD
><DT ><DT
@ -1623,7 +1721,7 @@ CLASS="PROPERTY"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN456" NAME="AEN471"
></A ></A
><H2 ><H2
>Conforming To</H2 >Conforming To</H2
@ -1662,14 +1760,14 @@ TARGET="_top"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN469" NAME="AEN484"
></A ></A
><H2 ><H2
>Notes</H2 >Notes</H2
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN471" NAME="AEN486"
></A ></A
><H3 ><H3
>Deleting Local Folders</H3 >Deleting Local Folders</H3
@ -1701,7 +1799,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN478" NAME="AEN493"
></A ></A
><H3 ><H3
>Multiple Instances</H3 >Multiple Instances</H3
@ -1730,7 +1828,7 @@ CLASS="PROPERTY"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN485" NAME="AEN500"
></A ></A
><H3 ><H3
>Copying Messages Between Folders</H3 >Copying Messages Between Folders</H3
@ -1760,7 +1858,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN491" NAME="AEN506"
></A ></A
><H3 ><H3
>Use with Evolution</H3 >Use with Evolution</H3
@ -1796,7 +1894,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN499" NAME="AEN514"
></A ></A
><H3 ><H3
>Use with KMail</H3 >Use with KMail</H3
@ -1804,19 +1902,33 @@ NAME="AEN499"
>At this time, I believe that <SPAN >At this time, I believe that <SPAN
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
> is not compatible > with Maildirs
is not compatible
with KMail. KMail cannot work in any mode other than to move with KMail. KMail cannot work in any mode other than to move
all messages out of all folders immediately, which (besides being annoying all messages out of all folders immediately, which (besides being annoying
and fundamentally broken) is incompatible with <SPAN and fundamentally broken) is incompatible with
<SPAN
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
>. >.
</P </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
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN504" NAME="AEN522"
></A ></A
><H3 ><H3
>Mailing List</H3 >Mailing List</H3
@ -1824,13 +1936,18 @@ NAME="AEN504"
>There is an OfflineIMAP mailing list available. >There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail to To subscribe, send the text "Subscribe" in the subject of a mail to
offlineimap-request@complete.org. To post, send the message to offlineimap-request@complete.org. To post, send the message to
offlineimap@complete.org. offlineimap@complete.org. Archives are available at
<A
HREF="http://lists.complete.org/offlineimap@complete.org/"
TARGET="_top"
>http://lists.complete.org/offlineimap@complete.org/</A
>.
</P </P
></DIV ></DIV
><DIV ><DIV
CLASS="REFSECT2" CLASS="REFSECT2"
><A ><A
NAME="AEN507" NAME="AEN526"
></A ></A
><H3 ><H3
>Bugs</H3 >Bugs</H3
@ -1856,12 +1973,12 @@ TARGET="_top"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN513" NAME="AEN532"
></A ></A
><H2 ><H2
>Copyright</H2 >Copyright</H2
><P ><P
>OfflineIMAP, and this manual, are Copyright &copy; 2002, 2003 John Goerzen.</P >OfflineIMAP, and this manual, are Copyright © 2002, 2003 John Goerzen.</P
><P ><P
> This program is free software; you can redistribute it and/or modify > 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 it under the terms of the GNU General Public License as published by
@ -1894,7 +2011,7 @@ CLASS="APPLICATION"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN522" NAME="AEN541"
></A ></A
><H2 ><H2
>Author</H2 >Author</H2
@ -1946,7 +2063,7 @@ TARGET="_top"
><DIV ><DIV
CLASS="REFSECT1" CLASS="REFSECT1"
><A ><A
NAME="AEN534" NAME="AEN553"
></A ></A
><H2 ><H2
>See Also</H2 >See Also</H2

BIN
offlineimap/head/manual.pdf
View File

Binary file not shown.

1754
offlineimap/head/manual.ps
View File

File diff suppressed because it is too large Load Diff

282
offlineimap/head/manual.txt
View File

@ -49,12 +49,22 @@ DESCRIPTION
responsible if this turns out to be wrong. responsible if this turns out to be wrong.
METHOD OF OPERATION METHOD OF OPERATION
OfflineIMAP operates by maintaining a hierarchy of mail folders in OfflineIMAP traditionally operates by maintaining a hierarchy of mail
Maildir format locally. Your own mail reader will read mail from this folders in Maildir format locally. Your own mail reader will read mail
tree, and need never know that the mail comes from IMAP. OfflineIMAP from this tree, and need never know that the mail comes from IMAP.
will detect changes to the mail folders on your IMAP server and your OfflineIMAP will detect changes to the mail folders on your IMAP server
own computer and bi-directionally synchronize them, copying, marking, and your own computer and bi-directionally synchronize them, copying,
and deleting messages as necessary. marking, and deleting messages as necessary.
With OfflineIMAP 4.0, a powerful new ability has been introduced -- the
program can now synchronize two IMAP servers with each other, with no
need to have a Maildir layer in-between. Many people use this if they
use a mail reader on their local machine that does not support
Maildirs. People may install an IMAP server on their local machine,
and point both OfflineIMAP and their mail reader of choice at it. This
is often preferable to the mail reader's own IMAP support since
OfflineIMAP supports many features (offline reading, for one) that most
IMAP-aware readers don't.
QUICK START QUICK START
If you have already installed OfflineIMAP system-wide, or your system If you have already installed OfflineIMAP system-wide, or your system
@ -74,8 +84,16 @@ QUICK START
[general] [general]
accounts = Test accounts = Test
[Test] [Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost remotehost = examplehost
remoteuser = jgoerzen remoteuser = jgoerzen
@ -122,7 +140,9 @@ INSTALLATION
modern mail readers have this support built-in, so you can choose modern mail readers have this support built-in, so you can choose
from a wide variety of mail servers. This format is also known as from a wide variety of mail servers. This format is also known as
the "qmail" format, so any mail reader compatible with it will work the "qmail" format, so any mail reader compatible with it will work
with OfflineIMAP. with OfflineIMAP. If you do not have a mail reader that supports
Maildir, you can often install a local IMAP server and point both
OfflineIMAP and your mail reader at it.
SYSTEM-WIDE INSTALLATION, DEBIAN SYSTEM-WIDE INSTALLATION, DEBIAN
If you are tracking Debian unstable, you may install OfflineIMAP by If you are tracking Debian unstable, you may install OfflineIMAP by
@ -209,12 +229,13 @@ OPTIONS
the results more sensible. the results more sensible.
-d requires one or more debugtypes, separated by commas. These -d requires one or more debugtypes, separated by commas. These
define what exactly will be debugged, and include two options: define what exactly will be debugged, and include three options:
imap and maildir. The imap option will enable IMAP protocol imap, maildir, and thread. The imap option will enable IMAP
stream and parsing debugging. Note that the output may contain protocol stream and parsing debugging. Note that the output may
passwords, so take care to remove that from the debugging output contain passwords, so take care to remove that from the debug-
before sending it to anyone else. The maildir option will ging output before sending it to anyone else. The maildir
enable debugging for certain Maildir operations. option will enable debugging for certain Maildir operations.
And thread will debug the threading model.
-o Run only once, ignoring all autorefresh settings in the configu- -o Run only once, ignoring all autorefresh settings in the configu-
ration file. ration file.
@ -224,52 +245,52 @@ OPTIONS
--help Show summary of options. --help Show summary of options.
-u interface -u interface
Specifies an alternative user interface module to use. This Specifies an alternative user interface module to use. This
overrides the defailt specified in the configuration file. The overrides the defailt specified in the configuration file. The
pre-defined options are listed in the User Interfaces section. pre-defined options are listed in the User Interfaces section.
USER INTERFACES USER INTERFACES
OfflineIMAP has a pluggable user interface system that lets you choose OfflineIMAP has a pluggable user interface system that lets you choose
how the program communicates information to you. There are two graphi- how the program communicates information to you. There are two graphi-
cal interfaces, two terminal interfaces, and two noninteractive inter- cal interfaces, two terminal interfaces, and two noninteractive inter-
faces suitable for scripting or logging purposes. The ui option in the faces suitable for scripting or logging purposes. The ui option in the
configuration file specifies user interface preferences. The -u com- configuration file specifies user interface preferences. The -u com-
mand-line option can override the configuration file setting. The mand-line option can override the configuration file setting. The
available values for the configuration file or command-line are available values for the configuration file or command-line are
described in this section. described in this section.
TK.BLINKENLIGHTS TK.BLINKENLIGHTS
Tk.Blinkenlights is an interface designed to be sleek, fun to watch, Tk.Blinkenlights is an interface designed to be sleek, fun to watch,
and informative of the overall picture of what OfflineIMAP is doing. I and informative of the overall picture of what OfflineIMAP is doing. I
consider it to be the best general-purpose interface in OfflineIMAP. consider it to be the best general-purpose interface in OfflineIMAP.
Tk.Blinkenlights contains, by default, a small window with a row of Tk.Blinkenlights contains, by default, a small window with a row of
LEDs, a small log, and a row of command buttons. The total size of the LEDs, a small log, and a row of command buttons. The total size of the
window is very small, so it uses little desktop space, yet it is quite window is very small, so it uses little desktop space, yet it is quite
functional. The optional, toggleable, log shows more detail about what functional. The optional, toggleable, log shows more detail about what
is happening and is color-coded to match the color of the lights. is happening and is color-coded to match the color of the lights.
Tk.Blinkenlights is the only user interface that has configurable Tk.Blinkenlights is the only user interface that has configurable
parameters; see the example offlineimap.conf for more details. parameters; see the example offlineimap.conf for more details.
Each light in the Blinkenlights interface represents a thread of execu- Each light in the Blinkenlights interface represents a thread of execu-
tion -- that is, a particular task that OfflineIMAP is performing right tion -- that is, a particular task that OfflineIMAP is performing right
now. The colors indicate what task the particular thread is perform- now. The colors indicate what task the particular thread is perform-
ing, and are as follows: ing, and are as follows:
Black indicates that this light's thread has terminated; it will light Black indicates that this light's thread has terminated; it will light
up again later when new threads start up. So, black indicates up again later when new threads start up. So, black indicates
no activity. no activity.
Red (Meaning 1) Red (Meaning 1)
is the color of the main program's thread, which basically does is the color of the main program's thread, which basically does
nothing but monitor the others. It might remind you of HAL 9000 nothing but monitor the others. It might remind you of HAL 9000
in 2001. in 2001.
Gray indicates that the thread is establishing a new connection to Gray indicates that the thread is establishing a new connection to
the IMAP server. the IMAP server.
Purple is the color of an account synchronization thread that is moni- Purple is the color of an account synchronization thread that is moni-
toring the progress of the folders in that account (not generat- toring the progress of the folders in that account (not generat-
ing any I/O). ing any I/O).
@ -279,7 +300,7 @@ USER INTERFACES
Blue is the color of a message synchronization controller thread. Blue is the color of a message synchronization controller thread.
Orange indicates that an actual message is being copied. (We use Orange indicates that an actual message is being copied. (We use
fuschia for fake messages.) fuschia for fake messages.)
Red (meaning 2) Red (meaning 2)
@ -292,68 +313,68 @@ USER INTERFACES
indicates that message flags are being removed. indicates that message flags are being removed.
Red / Black Flashing Red / Black Flashing
corresponds to the countdown timer that runs between synchro- corresponds to the countdown timer that runs between synchro-
nizations. nizations.
The name of this interfaces derives from a bit of computer history. The name of this interfaces derives from a bit of computer history.
Eric Raymond's Jargon File defines blinkenlights, in part, as: Eric Raymond's Jargon File defines blinkenlights, in part, as:
Front-panel diagnostic lights on a computer, esp. a dinosaur. Front-panel diagnostic lights on a computer, esp. a dinosaur.
Now that dinosaurs are rare, this term usually refers to status Now that dinosaurs are rare, this term usually refers to status
lights on a modem, network hub, or the like. lights on a modem, network hub, or the like.
This term derives from the last word of the famous blackletter- This term derives from the last word of the famous blackletter-
Gothic sign in mangled pseudo-German that once graced about half Gothic sign in mangled pseudo-German that once graced about half
the computer rooms in the English-speaking world. One version the computer rooms in the English-speaking world. One version
ran in its entirety as follows: ran in its entirety as follows:
ACHTUNG! ALLES LOOKENSPEEPERS! ACHTUNG! ALLES LOOKENSPEEPERS!
Das computermachine ist nicht fuer gefingerpoken und mitten- Das computermachine ist nicht fuer gefingerpoken und mitten-
grabben. Ist easy schnappen der springenwerk, blowenfusen und grabben. Ist easy schnappen der springenwerk, blowenfusen und
poppencorken mit spitzensparken. Ist nicht fuer gewerken bei poppencorken mit spitzensparken. Ist nicht fuer gewerken bei
das dumpkopfen. Das rubbernecken sichtseeren keepen das cotten- das dumpkopfen. Das rubbernecken sichtseeren keepen das cotten-
pickenen hans in das pockets muss; relaxen und watchen das pickenen hans in das pockets muss; relaxen und watchen das
blinkenlichten. blinkenlichten.
CURSES.BLINKENLIGHTS CURSES.BLINKENLIGHTS
Curses.Blinkenlights is an interface very similar to Tk.Blinkenlights, Curses.Blinkenlights is an interface very similar to Tk.Blinkenlights,
but is designed to be run in a console window (an xterm, Linux virtual but is designed to be run in a console window (an xterm, Linux virtual
terminal, etc.) Since it doesn't have access to graphics, it isn't terminal, etc.) Since it doesn't have access to graphics, it isn't
quite as pretty, but it still gets the job done. quite as pretty, but it still gets the job done.
Please see the Tk.Blinkenlights section above for more information Please see the Tk.Blinkenlights section above for more information
about the colors used in this interface. about the colors used in this interface.
TK.VERBOSEUI TK.VERBOSEUI
Tk.VerboseUI (formerly known as Tk.TkUI) is a graphical interface that Tk.VerboseUI (formerly known as Tk.TkUI) is a graphical interface that
presents a variable-sized window. In the window, each currently-exe- presents a variable-sized window. In the window, each currently-exe-
cuting thread has a section where its name and current status are dis- cuting thread has a section where its name and current status are dis-
played. This interface is best suited to people running on slower con- played. This interface is best suited to people running on slower con-
nections, as you get a lot of detail, but for fast connections, the nections, as you get a lot of detail, but for fast connections, the
detail may go by too quickly to be useful. People with fast connec- detail may go by too quickly to be useful. People with fast connec-
tions may wish to use Tk.Blinkenlights instead. tions may wish to use Tk.Blinkenlights instead.
TTY.TTYUI TTY.TTYUI
TTY.TTYUI interface is for people running in basic, non-color termi- TTY.TTYUI interface is for people running in basic, non-color termi-
nals. It prints out basic status messages and is generally friendly to nals. It prints out basic status messages and is generally friendly to
use on a console or xterm. use on a console or xterm.
NONINTERACTIVE.BASIC NONINTERACTIVE.BASIC
Noninteractive.Basic is designed for situations in which OfflineIMAP Noninteractive.Basic is designed for situations in which OfflineIMAP
will be run non-attended and the status of its execution will be will be run non-attended and the status of its execution will be
logged. You might use it, for instance, to have the system run auto- logged. You might use it, for instance, to have the system run auto-
matically and e-mail you the results of the synchronization. This user matically and e-mail you the results of the synchronization. This user
interface is not capable of reading a password from the keyboard; interface is not capable of reading a password from the keyboard;
account passwords must be specified using one of the configuration file account passwords must be specified using one of the configuration file
options. options.
NONINTERACTIVE.QUIET NONINTERACTIVE.QUIET
Noninteractive.Quiet is designed for non-attended running in situations Noninteractive.Quiet is designed for non-attended running in situations
where normal status messages are not desired. It will output nothing where normal status messages are not desired. It will output nothing
except errors and serious warnings. Like Noninteractive.Basic, this except errors and serious warnings. Like Noninteractive.Basic, this
user interface is not capable of reading a password from the keyboard; user interface is not capable of reading a password from the keyboard;
account passwords must be specified using one of the configuration file account passwords must be specified using one of the configuration file
options. options.
@ -362,19 +383,19 @@ EXAMPLES
mail any other examples you have that may be useful to me. mail any other examples you have that may be useful to me.
MULTIPLE ACCOUNTS WITH MUTT MULTIPLE ACCOUNTS WITH MUTT
This example shows you how to set up OfflineIMAP to synchronize multi- This example shows you how to set up OfflineIMAP to synchronize multi-
ple accounts with the mutt mail reader. ple accounts with the mutt mail reader.
Start by creating a directory to hold your folders by running mkdir Start by creating a directory to hold your folders by running mkdir
~/Mail. Then, in your ~/.offlineimaprc, specify: ~/Mail. Then, in your ~/.offlineimaprc, specify:
accounts = Personal, Work accounts = Personal, Work
Make sure that you have both a [Personal] and a [Work] section, each Make sure that you have both an [Account Personal] and an [Account
with different localfolder path names. Also, make sure to enable Work] section. The local repository for each account must have differ-
[mbnames]. ent localfolder path names. Also, make sure to enable [mbnames].
In each account section, write something like this: In each local repository section, write something like this:
localfolders = ~/Mail/Personal localfolders = ~/Mail/Personal
@ -391,14 +412,22 @@ EXAMPLES
UW-IMAPD AND REFERENCES UW-IMAPD AND REFERENCES
Some users with a UW-IMAPD server need to use OfflineIMAP's "reference" Some users with a UW-IMAPD server need to use OfflineIMAP's "reference"
feature to get at their mailboxes, specifying a reference of "~/Mail" feature to get at their mailboxes, specifying a reference of "~/Mail"
or "#mh/" depending on the configuration. The below configuration from or "#mh/" depending on the configuration. The below configuration from
docwhat@gerf.org shows using a reference of Mail, a nametrans that (originally from docwhat@gerf.org) shows using a reference of Mail, a
strips the leading Mail/ off incoming folder names, and a folderfilter nametrans that strips the leading Mail/ off incoming folder names, and
that limits the folders synced to just three. a folderfilter that limits the folders synced to just three.
[Gerf] [Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org remotehost = gerf.org
ssl = yes ssl = yes
remoteuser = docwhat remoteuser = docwhat
@ -417,15 +446,15 @@ EXAMPLES
holdconnectionopen = no holdconnectionopen = no
PYTHONFILE CONFIGURATION FILE OPTION PYTHONFILE CONFIGURATION FILE OPTION
You can have OfflineIMAP load up a Python file before evaluating the You can have OfflineIMAP load up a Python file before evaluating the
configuration file options that are Python expressions. This example configuration file options that are Python expressions. This example
is based on one supplied by Tommi Virtanen for this feature. is based on one supplied by Tommi Virtanen for this feature.
In ~/.offlineimap.rc, he adds these options: In ~/.offlineimap.rc, he adds these options:
[general] [general]
pythonfile=~/.offlineimap.py pythonfile=~/.offlineimap.py
[foo] [Repository foo]
foldersort=mycmp foldersort=mycmp
Then, the ~/.offlineimap.py file will contain: Then, the ~/.offlineimap.py file will contain:
@ -446,68 +475,75 @@ EXAMPLES
folders.sort(mycmp) folders.sort(mycmp)
print folders print folders
This code snippet illustrates how the foldersort option can be cus- This code snippet illustrates how the foldersort option can be cus-
tomized with a Python function from the pythonfile to always synchro- tomized with a Python function from the pythonfile to always synchro-
nize certain folders first. nize certain folders first.
ERRORS ERRORS
If you get one of some frequently-encountered or confusing errors, If you get one of some frequently-encountered or confusing errors,
please check this section. please check this section.
UID VALIDITY PROBLEM FOR FOLDER UID VALIDITY PROBLEM FOR FOLDER
IMAP servers use a unique ID (UID) to refer to a specific message. IMAP servers use a unique ID (UID) to refer to a specific message.
This number is guaranteed to be unique to a particular message forever. This number is guaranteed to be unique to a particular message forever.
No other message in the same folder will ever get the same UID. UIDs No other message in the same folder will ever get the same UID. UIDs
are an integral part of OfflineIMAP's synchronization scheme; they are are an integral part of OfflineIMAP's synchronization scheme; they are
used to match up messages on your computer to messages on the server. used to match up messages on your computer to messages on the server.
Sometimes, the UIDs on the server might get reset. Usually this will Sometimes, the UIDs on the server might get reset. Usually this will
happen if you delete and then recreate a folder. When you create a happen if you delete and then recreate a folder. When you create a
folder, the server will often start the UID back from 1. But folder, the server will often start the UID back from 1. But
OfflineIMAP might still have the UIDs from the previous folder by the OfflineIMAP might still have the UIDs from the previous folder by the
same name stored. OfflineIMAP will detect this condition and skip the same name stored. OfflineIMAP will detect this condition and skip the
folder. This is GOOD, because it prevents data loss. folder. This is GOOD, because it prevents data loss.
You can fix it by removing your local folder and cache data. For You can fix it by removing your local folder and cache data. For
instance, if your folders are under ~/Folders and the folder with the instance, if your folders are under ~/Folders and the folder with the
problem is INBOX, you'd type this: problem is INBOX, you'd type this:
rm -r ~/Folders/INBOX rm -r ~/Folders/INBOX
rm -r ~/.offlineimap/AccountName/INBOX rm -r ~/.offlineimap/Account-AccountName
rm -r ~/.offlineimap/Repository-RepositoryName
(Of course, replace AccountName with the account name as specified in (Of course, replace AccountName and RepositoryName with the names as
~/.offlineimaprc). specified in ~/.offlineimaprc).
Next time you run OfflineIMAP, it will re-download the folder with the Next time you run OfflineIMAP, it will re-download the folder with the
new UIDs. Note that the procedure specified above will lose any local new UIDs. Note that the procedure specified above will lose any local
changes made to the folder. changes made to the folder.
Some IMAP servers are broken and do not support UIDs properly. If you Some IMAP servers are broken and do not support UIDs properly. If you
continue to get this error for all your folders even after performing continue to get this error for all your folders even after performing
the above procedure, it is likely that your IMAP server falls into this the above procedure, it is likely that your IMAP server falls into this
category. OfflineIMAP is incompatible with such servers. Using category. OfflineIMAP is incompatible with such servers. Using
OfflineIMAP with them will not destroy any mail, but at the same time, OfflineIMAP with them will not destroy any mail, but at the same time,
it will not actually synchronize it either. (OfflineIMAP will detect it will not actually synchronize it either. (OfflineIMAP will detect
this condition and abort prior to synchronization.) this condition and abort prior to synchronization.)
This question comes up frequently on the OfflineIMAP mailing list
<URL:http://lists.complete.org/offlineimap@complete.org/>. You can
find a detailed discussion <URL:http://lists.com-
plete.org/offlineimap@complete.org/2003/04/msg00012.html.gz> of the
problem there.
OTHER FREQUENTLY ASKED QUESTIONS OTHER FREQUENTLY ASKED QUESTIONS
There are some other FAQs that might not fit into another section of There are some other FAQs that might not fit into another section of
the document, so they are discussed here. the document, so they are discussed here.
What platforms does OfflineIMAP run on? What platforms does OfflineIMAP run on?
It should run on most platforms supported by Python, which are It should run on most platforms supported by Python, which are
quite a few. quite a few.
I'm using Mutt. Other IMAP sync programs require me to use "set I'm using Mutt. Other IMAP sync programs require me to use "set
maildir_trash=yes". Do I need to do that with OfflineIMAP? maildir_trash=yes". Do I need to do that with OfflineIMAP?
No. OfflineIMAP is smart enough to figure out message deletion No. OfflineIMAP is smart enough to figure out message deletion
without this extra crutch. You'll get the best results if you without this extra crutch. You'll get the best results if you
don't use this setting, in fact. don't use this setting, in fact.
How do I specify the names of my folders? How do I specify the names of my folders?
You do not need to. OfflineIMAP is smart enough to automati- You do not need to. OfflineIMAP is smart enough to automati-
cally figure out what folders are present on the IMAP server and cally figure out what folders are present on the IMAP server and
synchronize them. You can use the folderfilter and foldertrans synchronize them. You can use the folderfilter and foldertrans
configuration file options to request certain folders and rename configuration file options to request certain folders and rename
them as they come in if you like. them as they come in if you like.
@ -515,33 +551,36 @@ OTHER FREQUENTLY ASKED QUESTIONS
Use the folderfilter option in the configuration file. Use the folderfilter option in the configuration file.
How can I add or delete a folder? How can I add or delete a folder?
OfflineIMAP does not currently provide this feature, but if you OfflineIMAP does not currently provide this feature, but if you
create a new folder on the IMAP server, it will be created create a new folder on the IMAP server, it will be created
locally automatically. locally automatically.
Are there any other warnings that I should be aware of? Are there any other warnings that I should be aware of?
Yes; see the Notes section below. Yes; see the Notes section below.
What is the mailbox name recorder (mbnames) for? What is the mailbox name recorder (mbnames) for?
Some mail readers, such as Mutt, are not capable of automati- Some mail readers, such as Mutt, are not capable of automati-
cally determining the names of your mailboxes. OfflineIMAP can cally determining the names of your mailboxes. OfflineIMAP can
help these programs by writing the names of the folders ni a help these programs by writing the names of the folders ni a
format you specify. See the example offlineimap.conf for format you specify. See the example offlineimap.conf for
details. details.
Can I synchronize multiple accounts with OfflineIMAP? Can I synchronize multiple accounts with OfflineIMAP?
Sure. Just name them all in the accounts line in the general Sure. Just name them all in the accounts line in the general
section of the configuration file, and add a per-account section section of the configuration file, and add a per-account section
for each one. for each one.
Does OfflineIMAP support POP? Does OfflineIMAP support POP?
No. POP is not robust enough to do a completely reliable multi- No. POP is not robust enough to do a completely reliable multi-
machine synchronization like OfflineIMAP can do. OfflineIMAP machine synchronization like OfflineIMAP can do. OfflineIMAP
will not support it. will not support it.
Does OfflineIMAP support mailbox formats other than Maildir? Does OfflineIMAP support mailbox formats other than Maildir?
Not at present. There is no technical reason not to; just no Not at present. There is no technical reason not to; just no
demand yet. Maildir is a superior format anyway. demand yet. Maildir is a superior format anyway. However,
OfflineIMAP 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 OfflineIMAP sync to that.
[technical] Why are your Maildir message filenames so huge? [technical] Why are your Maildir message filenames so huge?
OfflineIMAP has two relevant principles: 1) never modifying your OfflineIMAP has two relevant principles: 1) never modifying your
@ -644,27 +683,32 @@ NOTES
folder inside your OfflineIMAP storage location. You're now set! folder inside your OfflineIMAP storage location. You're now set!
USE WITH KMAIL USE WITH KMAIL
At this time, I believe that OfflineIMAP is not compatible with KMail. At this time, I believe that OfflineIMAP with Maildirs is not compati-
KMail cannot work in any mode other than to move all messages out of ble with KMail. KMail cannot work in any mode other than to move all
all folders immediately, which (besides being annoying and fundamen- messages out of all folders immediately, which (besides being annoying
tally broken) is incompatible with OfflineIMAP. and fundamentally broken) is incompatible with OfflineIMAP.
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.
MAILING LIST MAILING LIST
There is an OfflineIMAP mailing list available. To subscribe, send the There is an OfflineIMAP mailing list available. To subscribe, send the
text "Subscribe" in the subject of a mail to offlineimap-request@com- text "Subscribe" in the subject of a mail to offlineimap-request@com-
plete.org. To post, send the message to offlineimap@complete.org. plete.org. To post, send the message to offlineimap@complete.org.
Archives are available at
<URL:http://lists.complete.org/offlineimap@complete.org/>.
BUGS BUGS
Reports of bugs should be sent via e-mail to the OfflineIMAP bug-track- Reports of bugs should be sent via e-mail to the OfflineIMAP bug-track-
ing system (BTS) at offlineimap@bugs.complete.org or submitted online ing system (BTS) at offlineimap@bugs.complete.org or submitted online
using the web interface <URL:http://bugs.complete.org/>. using the web interface <URL:http://bugs.complete.org/>.
The Web site also lists all current bugs, where you can check their The Web site also lists all current bugs, where you can check their
status or contribute to fixing them. status or contribute to fixing them.
COPYRIGHT COPYRIGHT
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John OfflineIMAP, and this manual, are Copyright 2002, 2003 John Goerzen.
Goerzen.
This program is free software; you can redistribute it and/or modify it 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 the under the terms of the GNU General Public License as published by the
@ -704,4 +748,4 @@ SEE ALSO
John Goerzen 05 February 2003 OFFLINEIMAP(1) John Goerzen 22 April 2003 OFFLINEIMAP(1)

109
offlineimap/head/offlineimap.1
View File

@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches, .\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>. .\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "OFFLINEIMAP" "1" "05 February 2003" "John Goerzen" "OfflineIMAP Manual" .TH "OFFLINEIMAP" "1" "22 April 2003" "John Goerzen" "OfflineIMAP Manual"
.SH NAME .SH NAME
OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support
@ -58,13 +58,26 @@ with no warranty, so I am not responsible if this turns out
to be wrong. to be wrong.
.SS "METHOD OF OPERATION" .SS "METHOD OF OPERATION"
.PP .PP
\fBOfflineIMAP\fR operates by maintaining a hierarchy of \fBOfflineIMAP\fR traditionally
operates by maintaining a hierarchy of
mail folders in Maildir format locally. Your own mail mail folders in Maildir format locally. Your own mail
reader will read mail from this tree, and need never know reader will read mail from this tree, and need never know
that the mail comes from IMAP. \fBOfflineIMAP\fR will detect that the mail comes from IMAP. \fBOfflineIMAP\fR will detect
changes to the mail folders on your IMAP server and your own changes to the mail folders on your IMAP server and your own
computer and bi-directionally synchronize them, copying, computer and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary. marking, and deleting messages as necessary.
.PP
With \fBOfflineIMAP\fR 4.0, a powerful new ability has been
introduced -- the program can now synchronize two IMAP
servers with each other, with no need to have a Maildir
layer in-between. Many people use this if they use a mail
reader on their local machine that does not support
Maildirs. People may install an IMAP server on their local
machine, and point both \fBOfflineIMAP\fR and their mail reader
of choice at it. This is often preferable to the mail
reader's own IMAP support since \fBOfflineIMAP\fR supports many
features (offline reading, for one) that most IMAP-aware
readers don't.
.SH "QUICK START" .SH "QUICK START"
.PP .PP
If you have already installed \fBOfflineIMAP\fR system-wide, If you have already installed \fBOfflineIMAP\fR system-wide,
@ -87,8 +100,16 @@ command such as \fBcp offlineimap.conf.minimal ~/.offlineimaprc\fR will do it.
[general] [general]
accounts = Test accounts = Test
[Test] [Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost remotehost = examplehost
remoteuser = jgoerzen remoteuser = jgoerzen
.fi .fi
@ -143,11 +164,15 @@ If you intend to use the Tk interface, you must have Tkinter
Python must have been built with SSL support. Python must have been built with SSL support.
.TP 0.2i .TP 0.2i
\(bu \(bu
Have a mail reader that supports the Maildir mailbox format. Most Have a mail reader that supports the Maildir mailbox
modern mail readers have this support built-in, so you can choose from format. Most modern mail readers have this support
a wide variety of mail servers. This format is also known as the built-in, so you can choose from a wide variety of mail
"qmail" format, so any mail reader compatible with it will work with servers. This format is also known as the "qmail"
\fBOfflineIMAP\fR. format, so any mail reader compatible with it will work
with \fBOfflineIMAP\fR. If you do not have a mail reader
that supports Maildir, you can often install a local
IMAP server and point both \fBOfflineIMAP\fR and your mail
reader at it.
.SS "SYSTEM-WIDE INSTALLATION, DEBIAN" .SS "SYSTEM-WIDE INSTALLATION, DEBIAN"
.PP .PP
If you are tracking Debian unstable, you may install If you are tracking Debian unstable, you may install
@ -216,7 +241,8 @@ there are a few command-line options that you may set for
\fB-1\fR \fB-1\fR
Disable most multithreading operations and use Disable most multithreading operations and use
solely a single-connection solely a single-connection
sync. This effectively sets the \fImaxsyncaccounts\fR sync. This effectively sets the
\fImaxsyncaccounts\fR
and all \fImaxconnections\fR configuration file and all \fImaxconnections\fR configuration file
variables to 1. variables to 1.
.TP .TP
@ -251,13 +277,15 @@ on under the hood. I suggest that you use this with
\fB-d\fR requires one or more debugtypes, \fB-d\fR requires one or more debugtypes,
separated by commas. These define what exactly will be separated by commas. These define what exactly will be
debugged, and include two options: \fIimap\fR debugged, and include three options: \fIimap\fR,
and \fImaildir\fR. The \fIimap\fR \fImaildir\fR, and \fIthread\fR.
The \fIimap\fR
option will enable IMAP protocol stream and parsing debugging. Note option will enable IMAP protocol stream and parsing debugging. Note
that the output may contain passwords, so take care to remove that that the output may contain passwords, so take care to remove that
from the debugging output before sending it to anyone else. The from the debugging output before sending it to anyone else. The
\fImaildir\fR option will enable debugging for \fImaildir\fR option will enable debugging for
certain Maildir operations. certain Maildir operations. And \fIthread\fR
will debug the threading model.
.TP .TP
\fB-o\fR \fB-o\fR
Run only once, ignoring all Run only once, ignoring all
@ -435,12 +463,15 @@ Start by creating a directory to hold your folders by running
accounts = Personal, Work accounts = Personal, Work
.fi .fi
.PP .PP
Make sure that you have both a \fI[Personal]\fR Make sure that you have both an
and a \fI[Work]\fR section, each with different \fI[Account Personal]\fR
\fIlocalfolder\fR path names. Also, make sure and an \fI[Account Work]\fR section. The
local repository for each account must have different
\fIlocalfolder\fR path names.
Also, make sure
to enable \fI[mbnames]\fR. to enable \fI[mbnames]\fR.
.PP .PP
In each account section, write something like this: In each local repository section, write something like this:
.nf .nf
localfolders = ~/Mail/Personal localfolders = ~/Mail/Personal
@ -463,7 +494,7 @@ That's it!
Some users with a UW-IMAPD server need to use \fBOfflineIMAP\fR's Some users with a UW-IMAPD server need to use \fBOfflineIMAP\fR's
"reference" feature to get at their mailboxes, specifying a reference "reference" feature to get at their mailboxes, specifying a reference
of "~/Mail" or "#mh/" depending on the configuration. The below of "~/Mail" or "#mh/" depending on the configuration. The below
configuration from docwhat@gerf.org configuration from (originally from docwhat@gerf.org)
shows using a \fIreference\fR of Mail, a \fInametrans\fR shows using a \fIreference\fR of Mail, a \fInametrans\fR
that strips that strips
the leading Mail/ off incoming folder names, and a the leading Mail/ off incoming folder names, and a
@ -471,8 +502,16 @@ the leading Mail/ off incoming folder names, and a
limits the folders synced to just three. limits the folders synced to just three.
.nf .nf
[Gerf] [Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org remotehost = gerf.org
ssl = yes ssl = yes
remoteuser = docwhat remoteuser = docwhat
@ -502,7 +541,7 @@ In \fI~/.offlineimap.rc\fR, he adds these options:
.nf .nf
[general] [general]
pythonfile=~/.offlineimap.py pythonfile=~/.offlineimap.py
[foo] [Repository foo]
foldersort=mycmp foldersort=mycmp
.fi .fi
.PP .PP
@ -558,10 +597,12 @@ and the folder with the problem is INBOX, you'd type this:
.nf .nf
rm -r ~/Folders/INBOX rm -r ~/Folders/INBOX
rm -r ~/.offlineimap/AccountName/INBOX rm -r ~/.offlineimap/Account-\fIAccountName\fR
rm -r ~/.offlineimap/Repository-\fIRepositoryName\fR
.fi .fi
.PP .PP
(Of course, replace AccountName with the account name as specified (Of course, replace AccountName and RepositoryName
with the names as specified
in \fI~/.offlineimaprc\fR). in \fI~/.offlineimaprc\fR).
.PP .PP
Next time you run \fBOfflineIMAP\fR, it will re-download Next time you run \fBOfflineIMAP\fR, it will re-download
@ -576,6 +617,12 @@ this category. \fBOfflineIMAP\fR is incompatible with such servers.
Using \fBOfflineIMAP\fR with them will not destroy any mail, but at the same time, Using \fBOfflineIMAP\fR with them will not destroy any mail, but at the same time,
it will not actually synchronize it either. (\fBOfflineIMAP\fR will detect it will not actually synchronize it either. (\fBOfflineIMAP\fR will detect
this condition and abort prior to synchronization.) this condition and abort prior to synchronization.)
.PP
This question comes up frequently on the
\fBOfflineIMAP\fR
mailing list <URL:http://lists.complete.org/offlineimap@complete.org/>. You can find a
detailed
discussion <URL:http://lists.complete.org/offlineimap@complete.org/2003/04/msg00012.html.gz> of the problem there.
.SH "OTHER FREQUENTLY ASKED QUESTIONS" .SH "OTHER FREQUENTLY ASKED QUESTIONS"
.PP .PP
There are some other FAQs that might not fit into another section There are some other FAQs that might not fit into another section
@ -629,6 +676,10 @@ will not support it.
\fBDoes OfflineIMAP support mailbox formats other than Maildir?\fR \fBDoes OfflineIMAP support mailbox formats other than Maildir?\fR
Not at present. There is no technical reason not to; just no Not at present. There is no technical reason not to; just no
demand yet. Maildir is a superior format anyway. demand yet. Maildir is a superior format anyway.
However, \fBOfflineIMAP\fR 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
\fBOfflineIMAP\fR sync to that.
.TP .TP
\fB[technical] Why are your Maildir message filenames so huge?\fR \fB[technical] Why are your Maildir message filenames so huge?\fR
\fBOfflineIMAP\fR has two relevant principles: 1) never modifying your \fBOfflineIMAP\fR has two relevant principles: 1) never modifying your
@ -747,16 +798,24 @@ specify the name of the top-level folder
You're now set! You're now set!
.SS "USE WITH KMAIL" .SS "USE WITH KMAIL"
.PP .PP
At this time, I believe that \fBOfflineIMAP\fR is not compatible At this time, I believe that \fBOfflineIMAP\fR with Maildirs
is not compatible
with KMail. KMail cannot work in any mode other than to move with KMail. KMail cannot work in any mode other than to move
all messages out of all folders immediately, which (besides being annoying all messages out of all folders immediately, which (besides being annoying
and fundamentally broken) is incompatible with \fBOfflineIMAP\fR. and fundamentally broken) is incompatible with
\fBOfflineIMAP\fR.
.PP
However, I have made KMail version 3 work well with
\fBOfflineIMAP\fR by installing an IMAP server on my local
machine, having \fBOfflineIMAP\fR sync to that, and pointing
KMail at the same server.
.SS "MAILING LIST" .SS "MAILING LIST"
.PP .PP
There is an OfflineIMAP mailing list available. There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail to To subscribe, send the text "Subscribe" in the subject of a mail to
offlineimap-request@complete.org. To post, send the message to offlineimap-request@complete.org. To post, send the message to
offlineimap@complete.org. offlineimap@complete.org. Archives are available at
<URL:http://lists.complete.org/offlineimap@complete.org/>.
.SS "BUGS" .SS "BUGS"
.PP .PP
Reports of bugs should be sent via e-mail to the Reports of bugs should be sent via e-mail to the
@ -768,7 +827,7 @@ The Web site also lists all current bugs, where you can check their
status or contribute to fixing them. status or contribute to fixing them.
.SH "COPYRIGHT" .SH "COPYRIGHT"
.PP .PP
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John Goerzen. OfflineIMAP, and this manual, are Copyright © 2002, 2003 John Goerzen.
.PP .PP
This program is free software; you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by

8
offlineimap/head/offlineimap.conf.minimal
View File

@ -5,14 +5,14 @@
accounts = Test accounts = Test
[Account Test] [Account Test]
localrepository = Main localrepository = Local
remoterepository = Example remoterepository = Remote
[Repository Main] [Repository Local]
type = Maildir type = Maildir
localfolders = ~/Test localfolders = ~/Test
[Repository Example] [Repository Remote]
type = IMAP type = IMAP
remotehost = examplehost remotehost = examplehost
remoteuser = jgoerzen remoteuser = jgoerzen

105
offlineimap/head/offlineimap.sgml
View File

@ -10,7 +10,7 @@
<refentryinfo> <refentryinfo>
<address><email>jgoerzen@complete.org</email></address> <address><email>jgoerzen@complete.org</email></address>
<author><firstname>John</firstname><surname>Goerzen</surname></author> <author><firstname>John</firstname><surname>Goerzen</surname></author>
<date> $Date: 2003-04-17 13:25:30 -0500 (Thu, 17 Apr 2003) $ </date> <date> $Date: 2003-04-22 10:47:25 -0500 (Tue, 22 Apr 2003) $ </date>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
@ -93,7 +93,8 @@
<refsect2> <refsect2>
<title>Method of Operation</title> <title>Method of Operation</title>
<para>&OfflineIMAP; operates by maintaining a hierarchy of <para>&OfflineIMAP; traditionally
operates by maintaining a hierarchy of
mail folders in Maildir format locally. Your own mail mail folders in Maildir format locally. Your own mail
reader will read mail from this tree, and need never know reader will read mail from this tree, and need never know
that the mail comes from IMAP. &OfflineIMAP; will detect that the mail comes from IMAP. &OfflineIMAP; will detect
@ -101,6 +102,19 @@
computer and bi-directionally synchronize them, copying, computer and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary. marking, and deleting messages as necessary.
</para> </para>
<para>
With &OfflineIMAP; 4.0, a powerful new ability has been
introduced -- the program can now synchronize two IMAP
servers with each other, with no need to have a Maildir
layer in-between. Many people use this if they use a mail
reader on their local machine that does not support
Maildirs. People may install an IMAP server on their local
machine, and point both &OfflineIMAP; and their mail reader
of choice at it. This is often preferable to the mail
reader's own IMAP support since &OfflineIMAP; supports many
features (offline reading, for one) that most IMAP-aware
readers don't.
</para>
</refsect2> </refsect2>
</refsect1> </refsect1>
@ -127,8 +141,16 @@
<PROGRAMLISTING>[general] <PROGRAMLISTING>[general]
accounts = Test accounts = Test
[Test] [Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost remotehost = examplehost
remoteuser = jgoerzen remoteuser = jgoerzen
</PROGRAMLISTING> </PROGRAMLISTING>
@ -197,11 +219,16 @@ remoteuser = jgoerzen
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Have a mail reader that supports the Maildir mailbox format. Most Have a mail reader that supports the Maildir mailbox
modern mail readers have this support built-in, so you can choose from format. Most modern mail readers have this support
a wide variety of mail servers. This format is also known as the built-in, so you can choose from a wide variety of mail
"qmail" format, so any mail reader compatible with it will work with servers. This format is also known as the "qmail"
&OfflineIMAP;. format, so any mail reader compatible with it will work
with &OfflineIMAP;. If you do not have a mail reader
that supports Maildir, you can often install a local
IMAP server and point both &OfflineIMAP; and your mail
reader at it.
</para>
</itemizedlist> </itemizedlist>
</refsect2> </refsect2>
@ -293,7 +320,8 @@ cd offlineimap-x.y.z</ProgramListing>
<varlistentry><term>-1</term> <varlistentry><term>-1</term>
<listitem><para>Disable most multithreading operations and use <listitem><para>Disable most multithreading operations and use
solely a single-connection solely a single-connection
sync. This effectively sets the <property>maxsyncaccounts</property> sync. This effectively sets the
<property>maxsyncaccounts</property>
and all <property>maxconnections</property> configuration file and all <property>maxconnections</property> configuration file
variables to 1. variables to 1.
</para></listitem> </para></listitem>
@ -580,13 +608,16 @@ cd offlineimap-x.y.z</ProgramListing>
</para> </para>
<programlisting>accounts = Personal, Work</programlisting> <programlisting>accounts = Personal, Work</programlisting>
<para> <para>
Make sure that you have both a <property>[Personal]</property> Make sure that you have both an
and a <property>[Work]</property> section, each with different <property>[Account Personal]</property>
<property>localfolder</property> path names. Also, make sure and an <property>[Account Work]</property> section. The
local repository for each account must have different
<property>localfolder</> path names.
Also, make sure
to enable <property>[mbnames]</property>. to enable <property>[mbnames]</property>.
</para> </para>
<para> <para>
In each account section, write something like this: In each local repository section, write something like this:
</para> </para>
<programlisting>localfolders = ~/Mail/Personal</programlisting> <programlisting>localfolders = ~/Mail/Personal</programlisting>
<para> <para>
@ -608,15 +639,23 @@ spoolfile=+Personal/INBOX</programlisting>
<para>Some users with a UW-IMAPD server need to use &OfflineIMAP;'s <para>Some users with a UW-IMAPD server need to use &OfflineIMAP;'s
"reference" feature to get at their mailboxes, specifying a reference "reference" feature to get at their mailboxes, specifying a reference
of "~/Mail" or "#mh/" depending on the configuration. The below of "~/Mail" or "#mh/" depending on the configuration. The below
configuration from docwhat@gerf.org configuration from (originally from docwhat@gerf.org)
shows using a <property>reference</property> of Mail, a <property>nametrans</property> shows using a <property>reference</property> of Mail, a <property>nametrans</property>
that strips that strips
the leading Mail/ off incoming folder names, and a the leading Mail/ off incoming folder names, and a
<property>folderfilter</property> that <property>folderfilter</property> that
limits the folders synced to just three. limits the folders synced to just three.
</para> </para>
<programlisting>[Gerf] <programlisting>[Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org remotehost = gerf.org
ssl = yes ssl = yes
remoteuser = docwhat remoteuser = docwhat
@ -647,7 +686,7 @@ holdconnectionopen = no</programlisting>
</para> </para>
<programlisting>[general] <programlisting>[general]
pythonfile=~/.offlineimap.py pythonfile=~/.offlineimap.py
[foo] [Repository foo]
foldersort=mycmp</programlisting> foldersort=mycmp</programlisting>
<para> <para>
Then, the <filename>~/.offlineimap.py</filename> file will Then, the <filename>~/.offlineimap.py</filename> file will
@ -711,10 +750,12 @@ def test_mycmp():
</para> </para>
<programlisting>rm -r ~/Folders/INBOX <programlisting>rm -r ~/Folders/INBOX
rm -r ~/.offlineimap/AccountName/INBOX</programlisting> rm -r ~/.offlineimap/Account-<replaceable>AccountName</>
rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
<para> <para>
(Of course, replace AccountName with the account name as specified (Of course, replace AccountName and RepositoryName
with the names as specified
in <filename>~/.offlineimaprc</filename>). in <filename>~/.offlineimaprc</filename>).
</para> </para>
@ -733,6 +774,15 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
it will not actually synchronize it either. (&OfflineIMAP; will detect it will not actually synchronize it either. (&OfflineIMAP; will detect
this condition and abort prior to synchronization.) this condition and abort prior to synchronization.)
</para> </para>
<para>
This question comes up frequently on the
<ulink
url="http://lists.complete.org/offlineimap@complete.org/">&OfflineIMAP;
mailing list</ulink>. You can find a
<ulink
url="http://lists.complete.org/offlineimap@complete.org/2003/04/msg00012.html.gz">detailed
discussion</ulink> of the problem there.
</para>
</refsect2> </refsect2>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -814,6 +864,10 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
<varlistentry><term>Does &OfflineIMAP; support mailbox formats other than Maildir?</term> <varlistentry><term>Does &OfflineIMAP; support mailbox formats other than Maildir?</term>
<listitem><para>Not at present. There is no technical reason not to; just no <listitem><para>Not at present. There is no technical reason not to; just no
demand yet. Maildir is a superior format anyway. demand yet. Maildir is a superior format anyway.
However, &OfflineIMAP; 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
&OfflineIMAP sync to that.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
@ -942,10 +996,18 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
<refsect2> <refsect2>
<title>Use with KMail</title> <title>Use with KMail</title>
<para>At this time, I believe that &OfflineIMAP; is not compatible <para>At this time, I believe that &OfflineIMAP; with Maildirs
is not compatible
with KMail. KMail cannot work in any mode other than to move with KMail. KMail cannot work in any mode other than to move
all messages out of all folders immediately, which (besides being annoying all messages out of all folders immediately, which (besides being annoying
and fundamentally broken) is incompatible with &OfflineIMAP;. and fundamentally broken) is incompatible with
&OfflineIMAP;.
</para>
<para>
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.
</para> </para>
</refsect2> </refsect2>
@ -954,7 +1016,8 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
<para>There is an OfflineIMAP mailing list available. <para>There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail to To subscribe, send the text "Subscribe" in the subject of a mail to
offlineimap-request@complete.org. To post, send the message to offlineimap-request@complete.org. To post, send the message to
offlineimap@complete.org. offlineimap@complete.org. Archives are available at
<ulink url="http://lists.complete.org/offlineimap@complete.org/"></>.
</para> </para>
</refsect2> </refsect2>