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.
* Fixed the regular expression that fixes line endings to make sure to
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

245
offlineimap/head/manual.html
View File

@ -204,7 +204,8 @@ NAME="AEN56"
><SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> operates by maintaining a hierarchy of
> traditionally
operates by maintaining a hierarchy of
mail folders in Maildir format locally. Your own mail
reader will read mail from this tree, and need never know
that the mail comes from IMAP. <SPAN
@ -215,12 +216,34 @@ CLASS="APPLICATION"
computer and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary.
</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
CLASS="REFSECT1"
><A
NAME="AEN61"
NAME="AEN65"
></A
><H2
>Quick Start</H2
@ -271,8 +294,16 @@ CLASS="PROGRAMLISTING"
>[general]
accounts = Test
[Test]
[Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost
remoteuser = jgoerzen</PRE
><P
@ -317,7 +348,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN83"
NAME="AEN87"
></A
><H2
>Installation</H2
@ -345,7 +376,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN89"
NAME="AEN93"
></A
><H3
>Prerequisites</H3
@ -387,14 +418,21 @@ TARGET="_top"
></LI
><LI
><P
> Have a mail reader that supports the Maildir mailbox format. Most
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 the
"qmail" format, so any mail reader compatible with it will work with
<SPAN
> Have a mail reader that supports the Maildir mailbox
format. Most 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 the "qmail"
format, so any mail reader compatible with it will work
with <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
>.
>. If you do not have a mail reader
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
></UL
@ -402,7 +440,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN102"
NAME="AEN107"
></A
><H3
>System-Wide Installation, Debian</H3
@ -448,7 +486,7 @@ CLASS="COMMAND"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN114"
NAME="AEN119"
></A
><H3
>System-Wide Installation, Other</H3
@ -491,7 +529,7 @@ CLASS="COMMAND"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN124"
NAME="AEN129"
></A
><H3
>Single-Account Installation</H3
@ -576,7 +614,7 @@ CLASS="FILENAME"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN145"
NAME="AEN150"
></A
><H2
>Options</H2
@ -599,7 +637,8 @@ CLASS="VARIABLELIST"
><P
>Disable most multithreading operations and use
solely a single-connection
sync. This effectively sets the <SPAN
sync. This effectively sets the
<SPAN
CLASS="PROPERTY"
>maxsyncaccounts</SPAN
>
@ -705,14 +744,18 @@ CLASS="OPTION"
>-d</TT
> requires one or more debugtypes,
separated by commas. These define what exactly will be
debugged, and include two options: <SPAN
debugged, and include three options: <SPAN
CLASS="PROPERTY"
>imap</SPAN
>
and <SPAN
>,
<SPAN
CLASS="PROPERTY"
>maildir</SPAN
>. The <SPAN
>, and <SPAN
CLASS="PROPERTY"
>thread</SPAN
>.
The <SPAN
CLASS="PROPERTY"
>imap</SPAN
>
@ -723,7 +766,11 @@ CLASS="PROPERTY"
CLASS="PROPERTY"
>maildir</SPAN
> option will enable debugging for
certain Maildir operations.
certain Maildir operations. And <SPAN
CLASS="PROPERTY"
>thread</SPAN
>
will debug the threading model.
</P
></DD
><DT
@ -763,7 +810,7 @@ CLASS="REPLACEABLE"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN205"
NAME="AEN212"
></A
><H2
>User Interfaces</H2
@ -789,7 +836,7 @@ CLASS="OPTION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN211"
NAME="AEN218"
></A
><H3
>Tk.Blinkenlights</H3
@ -945,7 +992,7 @@ CLASS="FIRSTTERM"
>, in part, as:
</P
><A
NAME="AEN274"
NAME="AEN281"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
@ -982,7 +1029,7 @@ CLASS="EMPHASIS"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN280"
NAME="AEN287"
></A
><H3
>Curses.Blinkenlights</H3
@ -1000,7 +1047,7 @@ NAME="AEN280"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN284"
NAME="AEN291"
></A
><H3
>Tk.VerboseUI</H3
@ -1017,7 +1064,7 @@ NAME="AEN284"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN287"
NAME="AEN294"
></A
><H3
>TTY.TTYUI</H3
@ -1030,7 +1077,7 @@ NAME="AEN287"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN290"
NAME="AEN297"
></A
><H3
>Noninteractive.Basic</H3
@ -1050,7 +1097,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN294"
NAME="AEN301"
></A
><H3
>Noninteractive.Quiet</H3
@ -1067,7 +1114,7 @@ NAME="AEN294"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN297"
NAME="AEN304"
></A
><H2
>Examples</H2
@ -1079,7 +1126,7 @@ NAME="AEN297"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN300"
NAME="AEN307"
></A
><H3
>Multiple Accounts with Mutt</H3
@ -1105,25 +1152,28 @@ CLASS="FILENAME"
CLASS="PROGRAMLISTING"
>accounts = Personal, Work</PRE
><P
> Make sure that you have both a <SPAN
> Make sure that you have both an
<SPAN
CLASS="PROPERTY"
>[Personal]</SPAN
>[Account Personal]</SPAN
>
and a <SPAN
and an <SPAN
CLASS="PROPERTY"
>[Work]</SPAN
> section, each with different
>[Account Work]</SPAN
> section. The
local repository for each account must have different
<SPAN
CLASS="PROPERTY"
>localfolder</SPAN
> path names. Also, make sure
> path names.
Also, make sure
to enable <SPAN
CLASS="PROPERTY"
>[mbnames]</SPAN
>.
</P
><P
> In each account section, write something like this:
> In each local repository section, write something like this:
</P
><PRE
CLASS="PROGRAMLISTING"
@ -1149,7 +1199,7 @@ spoolfile=+Personal/INBOX</PRE
><DIV
CLASS="REFSECT2"
><A
NAME="AEN319"
NAME="AEN326"
></A
><H3
>UW-IMAPD and References</H3
@ -1160,7 +1210,7 @@ CLASS="APPLICATION"
>'s
"reference" feature to get at their mailboxes, specifying a reference
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
CLASS="PROPERTY"
>reference</SPAN
@ -1178,8 +1228,16 @@ CLASS="PROPERTY"
</P
><PRE
CLASS="PROGRAMLISTING"
>[Gerf]
>[Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org
ssl = yes
remoteuser = docwhat
@ -1200,7 +1258,7 @@ holdconnectionopen = no</PRE
><DIV
CLASS="REFSECT2"
><A
NAME="AEN327"
NAME="AEN334"
></A
><H3
>pythonfile Configuration File Option</H3
@ -1223,7 +1281,7 @@ CLASS="FILENAME"
CLASS="PROGRAMLISTING"
>[general]
pythonfile=~/.offlineimap.py
[foo]
[Repository foo]
foldersort=mycmp</PRE
><P
> Then, the <TT
@ -1266,7 +1324,7 @@ CLASS="PROPERTY"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN340"
NAME="AEN347"
></A
><H2
>Errors</H2
@ -1277,7 +1335,7 @@ NAME="AEN340"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN343"
NAME="AEN350"
></A
><H3
>UID validity problem for folder</H3
@ -1324,9 +1382,21 @@ CLASS="FILENAME"
><PRE
CLASS="PROGRAMLISTING"
>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
> (Of course, replace AccountName with the account name as specified
> (Of course, replace AccountName and RepositoryName
with the names as specified
in <TT
CLASS="FILENAME"
>~/.offlineimaprc</TT
@ -1359,12 +1429,30 @@ CLASS="APPLICATION"
> will detect
this condition and abort prior to synchronization.)
</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
CLASS="REFSECT1"
><A
NAME="AEN362"
NAME="AEN375"
></A
><H2
>Other Frequently Asked Questions</H2
@ -1515,6 +1603,16 @@ CLASS="APPLICATION"
><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
@ -1623,7 +1721,7 @@ CLASS="PROPERTY"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN456"
NAME="AEN471"
></A
><H2
>Conforming To</H2
@ -1662,14 +1760,14 @@ TARGET="_top"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN469"
NAME="AEN484"
></A
><H2
>Notes</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN471"
NAME="AEN486"
></A
><H3
>Deleting Local Folders</H3
@ -1701,7 +1799,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN478"
NAME="AEN493"
></A
><H3
>Multiple Instances</H3
@ -1730,7 +1828,7 @@ CLASS="PROPERTY"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN485"
NAME="AEN500"
></A
><H3
>Copying Messages Between Folders</H3
@ -1760,7 +1858,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN491"
NAME="AEN506"
></A
><H3
>Use with Evolution</H3
@ -1796,7 +1894,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT2"
><A
NAME="AEN499"
NAME="AEN514"
></A
><H3
>Use with KMail</H3
@ -1804,19 +1902,33 @@ NAME="AEN499"
>At this time, I believe that <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> is not compatible
> 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
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="AEN504"
NAME="AEN522"
></A
><H3
>Mailing List</H3
@ -1824,13 +1936,18 @@ NAME="AEN504"
>There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail 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
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN507"
NAME="AEN526"
></A
><H3
>Bugs</H3
@ -1856,12 +1973,12 @@ TARGET="_top"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN513"
NAME="AEN532"
></A
><H2
>Copyright</H2
><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
> 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
@ -1894,7 +2011,7 @@ CLASS="APPLICATION"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN522"
NAME="AEN541"
></A
><H2
>Author</H2
@ -1946,7 +2063,7 @@ TARGET="_top"
><DIV
CLASS="REFSECT1"
><A
NAME="AEN534"
NAME="AEN553"
></A
><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

112
offlineimap/head/manual.txt
View File

@ -49,12 +49,22 @@ DESCRIPTION
responsible if this turns out to be wrong.
METHOD OF OPERATION
OfflineIMAP operates by maintaining a hierarchy of mail folders in
Maildir format locally. Your own mail reader will read mail from this
tree, and need never know that the mail comes from IMAP. OfflineIMAP
will detect changes to the mail folders on your IMAP server and your
own computer and bi-directionally synchronize them, copying, marking,
and deleting messages as necessary.
OfflineIMAP traditionally operates by maintaining a hierarchy of mail
folders in Maildir format locally. Your own mail reader will read mail
from this tree, and need never know that the mail comes from IMAP.
OfflineIMAP will detect changes to the mail folders on your IMAP server
and your own computer and bi-directionally synchronize them, copying,
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
If you have already installed OfflineIMAP system-wide, or your system
@ -74,8 +84,16 @@ QUICK START
[general]
accounts = Test
[Test]
[Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost
remoteuser = jgoerzen
@ -122,7 +140,9 @@ INSTALLATION
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
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
If you are tracking Debian unstable, you may install OfflineIMAP by
@ -209,12 +229,13 @@ OPTIONS
the results more sensible.
-d requires one or more debugtypes, separated by commas. These
define what exactly will be debugged, and include two options:
imap and maildir. The imap option will enable IMAP protocol
stream and parsing debugging. Note that the output may contain
passwords, so take care to remove that from the debugging output
before sending it to anyone else. The maildir option will
enable debugging for certain Maildir operations.
define what exactly will be debugged, and include three options:
imap, maildir, and thread. The imap option will enable IMAP
protocol stream and parsing debugging. Note that the output may
contain passwords, so take care to remove that from the debug-
ging output before sending it to anyone else. The maildir
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-
ration file.
@ -370,11 +391,11 @@ EXAMPLES
accounts = Personal, Work
Make sure that you have both a [Personal] and a [Work] section, each
with different localfolder path names. Also, make sure to enable
[mbnames].
Make sure that you have both an [Account Personal] and an [Account
Work] section. The local repository for each account must have differ-
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
@ -393,12 +414,20 @@ EXAMPLES
Some users with a UW-IMAPD server need to use OfflineIMAP's "reference"
feature to get at their mailboxes, specifying a reference of "~/Mail"
or "#mh/" depending on the configuration. The below configuration from
docwhat@gerf.org shows using a reference of Mail, a nametrans that
strips the leading Mail/ off incoming folder names, and a folderfilter
that limits the folders synced to just three.
(originally from docwhat@gerf.org) shows using a reference of Mail, a
nametrans that strips the leading Mail/ off incoming folder names, and
a folderfilter that limits the folders synced to just three.
[Gerf]
[Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org
ssl = yes
remoteuser = docwhat
@ -425,7 +454,7 @@ EXAMPLES
[general]
pythonfile=~/.offlineimap.py
[foo]
[Repository foo]
foldersort=mycmp
Then, the ~/.offlineimap.py file will contain:
@ -473,10 +502,11 @@ ERRORS
problem is INBOX, you'd type this:
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
~/.offlineimaprc).
(Of course, replace AccountName and RepositoryName with the names as
specified in ~/.offlineimaprc).
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
@ -490,6 +520,12 @@ ERRORS
it will not actually synchronize it either. (OfflineIMAP will detect
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
There are some other FAQs that might not fit into another section of
the document, so they are discussed here.
@ -541,7 +577,10 @@ OTHER FREQUENTLY ASKED QUESTIONS
Does OfflineIMAP support mailbox formats other than Maildir?
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?
OfflineIMAP has two relevant principles: 1) never modifying your
@ -644,15 +683,21 @@ NOTES
folder inside your OfflineIMAP storage location. You're now set!
USE WITH KMAIL
At this time, I believe that OfflineIMAP 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 fundamen-
tally broken) is incompatible with OfflineIMAP.
At this time, I believe that OfflineIMAP with Maildirs is not compati-
ble with KMail. KMail cannot work in any mode other than to move all
messages out of all folders immediately, which (besides being annoying
and fundamentally broken) is incompatible with OfflineIMAP.
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
There is an OfflineIMAP mailing list available. To subscribe, send the
text "Subscribe" in the subject of a mail to offlineimap-request@com-
plete.org. To post, send the message to offlineimap@complete.org.
Archives are available at
<URL:http://lists.complete.org/offlineimap@complete.org/>.
BUGS
Reports of bugs should be sent via e-mail to the OfflineIMAP bug-track-
@ -663,8 +708,7 @@ NOTES
status or contribute to fixing them.
COPYRIGHT
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John
Goerzen.
OfflineIMAP, and this manual, are Copyright 2002, 2003 John Goerzen.
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
@ -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/>
.\" Please send any bug reports, improvements, comments, patches,
.\" 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
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.
.SS "METHOD OF OPERATION"
.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
reader will read mail from this tree, and need never know
that the mail comes from IMAP. \fBOfflineIMAP\fR will detect
changes to the mail folders on your IMAP server and your own
computer and bi-directionally synchronize them, copying,
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"
.PP
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]
accounts = Test
[Test]
[Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost
remoteuser = jgoerzen
.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.
.TP 0.2i
\(bu
Have a mail reader that supports the Maildir mailbox format. Most
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 the
"qmail" format, so any mail reader compatible with it will work with
\fBOfflineIMAP\fR.
Have a mail reader that supports the Maildir mailbox
format. Most 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 the "qmail"
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"
.PP
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
Disable most multithreading operations and use
solely a single-connection
sync. This effectively sets the \fImaxsyncaccounts\fR
sync. This effectively sets the
\fImaxsyncaccounts\fR
and all \fImaxconnections\fR configuration file
variables to 1.
.TP
@ -251,13 +277,15 @@ on under the hood. I suggest that you use this with
\fB-d\fR requires one or more debugtypes,
separated by commas. These define what exactly will be
debugged, and include two options: \fIimap\fR
and \fImaildir\fR. The \fIimap\fR
debugged, and include three options: \fIimap\fR,
\fImaildir\fR, and \fIthread\fR.
The \fIimap\fR
option will enable IMAP protocol stream and parsing debugging. Note
that the output may contain passwords, so take care to remove that
from the debugging output before sending it to anyone else. The
\fImaildir\fR option will enable debugging for
certain Maildir operations.
certain Maildir operations. And \fIthread\fR
will debug the threading model.
.TP
\fB-o\fR
Run only once, ignoring all
@ -435,12 +463,15 @@ Start by creating a directory to hold your folders by running
accounts = Personal, Work
.fi
.PP
Make sure that you have both a \fI[Personal]\fR
and a \fI[Work]\fR section, each with different
\fIlocalfolder\fR path names. Also, make sure
Make sure that you have both an
\fI[Account Personal]\fR
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.
.PP
In each account section, write something like this:
In each local repository section, write something like this:
.nf
localfolders = ~/Mail/Personal
@ -463,7 +494,7 @@ That's it!
Some users with a UW-IMAPD server need to use \fBOfflineIMAP\fR's
"reference" feature to get at their mailboxes, specifying a reference
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
that strips
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.
.nf
[Gerf]
[Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org
ssl = yes
remoteuser = docwhat
@ -502,7 +541,7 @@ In \fI~/.offlineimap.rc\fR, he adds these options:
.nf
[general]
pythonfile=~/.offlineimap.py
[foo]
[Repository foo]
foldersort=mycmp
.fi
.PP
@ -558,10 +597,12 @@ and the folder with the problem is INBOX, you'd type this:
.nf
rm -r ~/Folders/INBOX
rm -r ~/.offlineimap/AccountName/INBOX
rm -r ~/.offlineimap/Account-\fIAccountName\fR
rm -r ~/.offlineimap/Repository-\fIRepositoryName\fR
.fi
.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).
.PP
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,
it will not actually synchronize it either. (\fBOfflineIMAP\fR will detect
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"
.PP
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
Not at present. There is no technical reason not to; just no
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
\fB[technical] Why are your Maildir message filenames so huge?\fR
\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!
.SS "USE WITH KMAIL"
.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
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"
.PP
There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail 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"
.PP
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.
.SH "COPYRIGHT"
.PP
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John Goerzen.
OfflineIMAP, and this manual, are Copyright © 2002, 2003 John Goerzen.
.PP
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

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

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

105
offlineimap/head/offlineimap.sgml
View File

@ -10,7 +10,7 @@
<refentryinfo>
<address><email>jgoerzen@complete.org</email></address>
<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>
<refmeta>
@ -93,7 +93,8 @@
<refsect2>
<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
reader will read mail from this tree, and need never know
that the mail comes from IMAP. &OfflineIMAP; will detect
@ -101,6 +102,19 @@
computer and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary.
</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>
</refsect1>
@ -127,8 +141,16 @@
<PROGRAMLISTING>[general]
accounts = Test
[Test]
[Account Test]
localrepository = Local
remoterepository = Remote
[Repository Local]
type = Maildir
localfolders = ~/Test
[Repository Remote]
type = IMAP
remotehost = examplehost
remoteuser = jgoerzen
</PROGRAMLISTING>
@ -197,11 +219,16 @@ remoteuser = jgoerzen
</listitem>
<listitem>
<para>
Have a mail reader that supports the Maildir mailbox format. Most
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 the
"qmail" format, so any mail reader compatible with it will work with
&OfflineIMAP;.
Have a mail reader that supports the Maildir mailbox
format. Most 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 the "qmail"
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>
</refsect2>
@ -293,7 +320,8 @@ cd offlineimap-x.y.z</ProgramListing>
<varlistentry><term>-1</term>
<listitem><para>Disable most multithreading operations and use
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
variables to 1.
</para></listitem>
@ -580,13 +608,16 @@ cd offlineimap-x.y.z</ProgramListing>
</para>
<programlisting>accounts = Personal, Work</programlisting>
<para>
Make sure that you have both a <property>[Personal]</property>
and a <property>[Work]</property> section, each with different
<property>localfolder</property> path names. Also, make sure
Make sure that you have both an
<property>[Account Personal]</property>
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>.
</para>
<para>
In each account section, write something like this:
In each local repository section, write something like this:
</para>
<programlisting>localfolders = ~/Mail/Personal</programlisting>
<para>
@ -608,15 +639,23 @@ spoolfile=+Personal/INBOX</programlisting>
<para>Some users with a UW-IMAPD server need to use &OfflineIMAP;'s
"reference" feature to get at their mailboxes, specifying a reference
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>
that strips
the leading Mail/ off incoming folder names, and a
<property>folderfilter</property> that
limits the folders synced to just three.
</para>
<programlisting>[Gerf]
<programlisting>[Account Gerf]
localrepository = GerfLocal
remoterepository = GerfRemote
[Repository GerfLocal]
type = Maildir
localfolders = ~/Mail
[Repository GerfRemote]
type = IMAP
remotehost = gerf.org
ssl = yes
remoteuser = docwhat
@ -647,7 +686,7 @@ holdconnectionopen = no</programlisting>
</para>
<programlisting>[general]
pythonfile=~/.offlineimap.py
[foo]
[Repository foo]
foldersort=mycmp</programlisting>
<para>
Then, the <filename>~/.offlineimap.py</filename> file will
@ -711,10 +750,12 @@ def test_mycmp():
</para>
<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>
(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>).
</para>
@ -733,6 +774,15 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
it will not actually synchronize it either. (&OfflineIMAP; will detect
this condition and abort prior to synchronization.)
</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>
</refsect1>
<refsect1>
@ -814,6 +864,10 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
<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
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>
</varlistentry>
@ -942,10 +996,18 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
<refsect2>
<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
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>
</refsect2>
@ -954,7 +1016,8 @@ rm -r ~/.offlineimap/AccountName/INBOX</programlisting>
<para>There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail 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>
</refsect2>