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

/offlineimap/head: changeset 577

Browse Source 
Fixed various doc bugs
This commit is contained in:
jgoerzen 2004-06-04 21:26:30 +01:00
parent c8001aa5cf
commit e95dae8c3f
9 changed files with 656 additions and 468 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
offlineimap/head/debian/changelog
View File

@ -1,8 +1,14 @@
offlineimap (4.0.3) unstable; urgency=low offlineimap (4.0.3) unstable; urgency=low
* Fixed version numbers to read 4.0.3. * Fixed version numbers to read 4.0.3. Closes: #220536.
* Switched defaults from Python 2.2 to Python 2.3. * Switched defaults from Python 2.2 to Python 2.3.
Closes: #237560. Closes: #237560, #239018.
* Fixed description typo. Closes: #211251.
* Fixed nametrans example. Closes: #252644.
* Applied patch from Johannes Berg for mycmp example in manual.
Closes: #252645.
* Fixed typos in manual. Closes: #252646.
* Regenerated docs.
-- John Goerzen <jgoerzen@complete.org> Fri, 4 Jun 2004 10:10:00 -0500 -- John Goerzen <jgoerzen@complete.org> Fri, 4 Jun 2004 10:10:00 -0500

2
offlineimap/head/debian/control
View File

@ -11,7 +11,7 @@ Depends: python2.3
Suggests: python2.3-tk Suggests: python2.3-tk
Description: IMAP/Maildir synchronization and reader support Description: IMAP/Maildir synchronization and reader support
OfflineIMAP is a tool to simplify your e-mail reading. With OfflineIMAP is a tool to simplify your e-mail reading. With
OfflimeIMAP, you can: OfflineIMAP, you can:
. .
* Read the same mailbox from multiple computers, and have your * Read the same mailbox from multiple computers, and have your
changes (deletions, etc.) be automatically reflected on changes (deletions, etc.) be automatically reflected on

93
offlineimap/head/manual.html
View File

@ -247,7 +247,7 @@ NAME="AEN67"
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
> system-wide, > system-wide,
or your system adminstrator has done that for you, your task or your system administrator has done that for you, your task
for setting up <SPAN for setting up <SPAN
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
@ -469,7 +469,7 @@ CLASS="COMMAND"
package. Then, skip to <A package. Then, skip to <A
HREF="#CONFIGURATION" HREF="#CONFIGURATION"
><I ><I
>Configruation</I >Configuration</I
></A ></A
> below. You will type <B > below. You will type <B
CLASS="COMMAND" CLASS="COMMAND"
@ -512,7 +512,7 @@ CLASS="COMMAND"
Next, proceed to <A Next, proceed to <A
HREF="#CONFIGURATION" HREF="#CONFIGURATION"
><I ><I
>Configruation</I >Configuration</I
></A ></A
> below. You will type <B > below. You will type <B
CLASS="COMMAND" CLASS="COMMAND"
@ -564,7 +564,7 @@ CLASS="REFSECT1"
NAME="CONFIGURATION" NAME="CONFIGURATION"
></A ></A
><H2 ><H2
>Configruation</H2 >Configuration</H2
><P ><P
> <SPAN > <SPAN
CLASS="APPLICATION" CLASS="APPLICATION"
@ -797,7 +797,7 @@ CLASS="REPLACEABLE"
><DD ><DD
><P ><P
>Specifies an alternative user interface module >Specifies an alternative user interface module
to use. This overrides the defailt specified in the to use. This overrides the default specified in the
configuration file. The pre-defined options are listed in configuration file. The pre-defined options are listed in
the User Interfaces section.</P the User Interfaces section.</P
></DD ></DD
@ -943,7 +943,7 @@ CLASS="CITATION"
><DD ><DD
><P ><P
>indicates that an actual message is being copied. >indicates that an actual message is being copied.
(We use fuschia for fake messages.) (We use fuchsia for fake messages.)
</P </P
></DD ></DD
><DT ><DT
@ -1293,10 +1293,14 @@ CLASS="PROGRAMLISTING"
def mycmp(x, y): def mycmp(x, y):
for prefix in prioritized: for prefix in prioritized:
if x.startswith(prefix): xsw = x.startswith(prefix)
return -1 ysw = y.startswith(prefix)
elif y.startswith(prefix): if xsw and ysw:
return +1 return cmp(x, y)
elif xsw:
return -1
elif ysw:
return +1
return cmp(x, y) return cmp(x, y)
def test_mycmp(): def test_mycmp():
@ -1556,7 +1560,7 @@ CLASS="APPLICATION"
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
> can help these programs by writing the names > can help these programs by writing the names
of the folders ni a format you specify. See the example of the folders in a format you specify. See the example
<TT <TT
CLASS="FILENAME" CLASS="FILENAME"
>offlineimap.conf</TT >offlineimap.conf</TT
@ -1782,7 +1786,7 @@ NAME="AEN499"
CLASS="APPLICATION" CLASS="APPLICATION"
>OfflineIMAP</SPAN >OfflineIMAP</SPAN
> does a two-way synchronization. That is, if you > does a two-way synchronization. That is, if you
make a change to the mail on the server, it will be propogated to your make a change to the mail on the server, it will be propagated to your
local copy, and vise-versa. Some people might think that it would be local copy, and vise-versa. Some people might think that it would be
wise to just delete all their local mail folders periodically. If you wise to just delete all their local mail folders periodically. If you
do this with <SPAN do this with <SPAN
@ -1995,7 +1999,7 @@ CLASS="APPLICATION"
> starts up (relating to ConfigParser or > starts up (relating to ConfigParser or
AccountHashGenerator) and the AccountHashGenerator) and the
configuration file. This is because the config file format configuration file. This is because the config file format
had to change to accomodate new features in 4.0. Fortunately, had to change to accommodate new features in 4.0. Fortunately,
it's not difficult to adjust it to suit. it's not difficult to adjust it to suit.
</P </P
><P ><P
@ -2147,6 +2151,69 @@ CLASS="APPLICATION"
>(1) >(1)
</P </P
></DIV ></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN585"
></A
><H2
>History</H2
><P
> Detailed history may be found in the file ChangeLog in the
<SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> distribution. Feature and bug histories may be
found in the file debian/changelog which, despite its name, is
not really Debian-specific. This section provides a large
overview.
</P
><P
> Development on <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> began on June 18, 2002. Version
1.0.0 was released three days later on June 21, 2002. Point
releases followed, including speed optimizations and some
compatibility fixes.
</P
><P
>Version 2.0.0 was released on July 3, 2002, and
represented the first time the synchronization became
multithreaded and, to the best of my knowledge, the first
multithreaded IMAP syncrhonizing application in existance.
The last 2.0.x release, 2.0.8, was made on July 9.
</P
><P
> Version 3.0.0 was released on July 11, 2002, and introduced
modular user interfaces and the first GUI interface for
<SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
>. This manual also was introduced with 3.0.0,
along with many command-line options. Version 3.1.0 was
released on July 21, adding the Noninteractive user
interfaces, profiling support, and several bugfixes. 3.2.0
was released on July 24, adding support for the Blinkenlights
GUI interface. <SPAN
CLASS="APPLICATION"
>OfflineIMAP</SPAN
> entered maintenance mode for
awhile, as it had reached a feature-complete milestone in my
mind.
</P
><P
> The 3.99.x branch began in on October 7, 2002, to begin work
for 4.0. The Curses.Blinkenlights interface was added in
3.99.6, and many architectural changes were made.
</P
><P
> 4.0.0 was released on July 18, 2003, including the ability to
synchronize directly between two IMAP servers, the first
re-architecting of the configuration file to refine the
notion of an account, and the new Curses interface.
</P
></DIV
></DIV ></DIV
></BODY ></BODY
></HTML ></HTML

BIN
offlineimap/head/manual.pdf
View File

Binary file not shown.

749
offlineimap/head/manual.ps
View File

File diff suppressed because it is too large Load Diff

216
offlineimap/head/manual.txt
View File

@ -70,7 +70,7 @@ DESCRIPTION
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
adminstrator has done that for you, your task for setting up administrator has done that for you, your task for setting up
OfflineIMAP for the first time is quite simple. You just need to set OfflineIMAP for the first time is quite simple. You just need to set
up your configuration file, make your folder directory, and run it! up your configuration file, make your folder directory, and run it!
@ -182,7 +182,7 @@ INSTALLATION
above and then type ./offlineimap.py; there is no installation step above and then type ./offlineimap.py; there is no installation step
necessary. necessary.
CONFIGRUATION CONFIGURATION
OfflineIMAP is regulated by a configuration file that is normally OfflineIMAP is regulated by a configuration file that is normally
stored in ~/.offlineimaprc. OfflineIMAP ships with a file named stored in ~/.offlineimaprc. OfflineIMAP ships with a file named
offlineimap.conf that you should copy to that location and then edit. offlineimap.conf that you should copy to that location and then edit.
@ -254,7 +254,7 @@ 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 default 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
@ -308,8 +308,8 @@ 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 fuch-
fuschia for fake messages.) sia for fake messages.)
Red (meaning 2) Red (meaning 2)
indicates that a message is being deleted. indicates that a message is being deleted.
@ -471,10 +471,14 @@ EXAMPLES
def mycmp(x, y): def mycmp(x, y):
for prefix in prioritized: for prefix in prioritized:
if x.startswith(prefix): xsw = x.startswith(prefix)
return -1 ysw = y.startswith(prefix)
elif y.startswith(prefix): if xsw and ysw:
return +1 return cmp(x, y)
elif xsw:
return -1
elif ysw:
return +1
return cmp(x, y) return cmp(x, y)
def test_mycmp(): def test_mycmp():
@ -573,7 +577,7 @@ OTHER FREQUENTLY ASKED QUESTIONS
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 in a
format you specify. See the example offlineimap.conf for format you specify. See the example offlineimap.conf for
details. details.
@ -596,35 +600,36 @@ OTHER FREQUENTLY ASKED QUESTIONS
[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
messages in any way and 2) ensuring 100% reliable synchroniza- messages in any way and 2) ensuring 100% reliable
tions. In order to do a reliable sync, OfflineIMAP must have a synchronizations. In order to do a reliable sync, OfflineIMAP
way to uniquely identify each e-mail. Three pieces of informa- must have a way to uniquely identify each e-mail. Three pieces
tion are required to do this: your account name, the folder of information are required to do this: your account name, the
name, and the message UID. The account name can be calculated folder name, and the message UID. The account name can be cal-
from the path in which your messages are. The folder name can culated from the path in which your messages are. The folder
usually be as well, BUT some mail clients move messages between name can usually be as well, BUT some mail clients move messages
folders by simply moving the file, leaving the name intact. between folders by simply moving the file, leaving the name
intact.
So, OfflineIMAP must store both a UID folder ID. The folder ID So, OfflineIMAP must store both a UID folder ID. The folder ID
is necessary so OfflineIMAP can detect a message moved to a dif- is necessary so OfflineIMAP can detect a message moved to a dif-
ferent folder. OfflineIMAP stores the UID (U= number) and an ferent folder. OfflineIMAP stores the UID (U= number) and an
md5sum of the foldername (FMD5= number) to facilitate this. md5sum of the foldername (FMD5= number) to facilitate this.
What is the speed of OfflineIMAP's sync? What is the speed of OfflineIMAP's sync?
OfflineIMAP versions 2.0 and above contain a multithreaded sys- OfflineIMAP versions 2.0 and above contain a multithreaded sys-
tem. A good way to experiment is by setting maxsyncaccounts to tem. A good way to experiment is by setting maxsyncaccounts to
3 and maxconnections to 3 in each account clause. 3 and maxconnections to 3 in each account clause.
This lets OfflineIMAP open up multiple connections simultane- This lets OfflineIMAP open up multiple connections simultane-
ously. That will let it process multiple folders and messages ously. That will let it process multiple folders and messages
at once. In most cases, this will increase performance of the at once. In most cases, this will increase performance of the
sync. sync.
Don't set the number too high. If you do that, things might Don't set the number too high. If you do that, things might
actually slow down as your link gets saturated. Also, too many actually slow down as your link gets saturated. Also, too many
connections can cause mail servers to have excessive load. connections can cause mail servers to have excessive load.
Administrators might take unkindly to this, and the server might Administrators might take unkindly to this, and the server might
bog down. There are many variables in the optimal setting; bog down. There are many variables in the optimal setting;
experimentation may help. experimentation may help.
An informal benchmark yields these results for my setup: An informal benchmark yields these results for my setup:
@ -647,7 +652,7 @@ CONFORMING TO
o CRAM-MD5 as specified in RFC2195 o CRAM-MD5 as specified in RFC2195
o Maildir as specified in the Maildir manpage o Maildir as specified in the Maildir manpage
<URL:http://www.qmail.org/qmail-manual-html/man5/maildir.html> and <URL:http://www.qmail.org/qmail-manual-html/man5/maildir.html> and
the qmail website <URL:http://cr.yp.to/proto/maildir.html>. the qmail website <URL:http://cr.yp.to/proto/maildir.html>.
@ -655,133 +660,166 @@ CONFORMING TO
NOTES NOTES
DELETING LOCAL FOLDERS DELETING LOCAL FOLDERS
OfflineIMAP does a two-way synchronization. That is, if you make a OfflineIMAP does a two-way synchronization. That is, if you make a
change to the mail on the server, it will be propogated to your local change to the mail on the server, it will be propagated to your local
copy, and vise-versa. Some people might think that it would be wise to copy, and vise-versa. Some people might think that it would be wise to
just delete all their local mail folders periodically. If you do this just delete all their local mail folders periodically. If you do this
with OfflineIMAP, remember to also remove your local status cache with OfflineIMAP, remember to also remove your local status cache
(~/.offlineimap by default). Otherwise, OfflineIMAP will take this as (~/.offlineimap by default). Otherwise, OfflineIMAP will take this as
an intentional deletion of many messages and will interpret your action an intentional deletion of many messages and will interpret your action
as requesting them to be deleted from the server as well. (If you as requesting them to be deleted from the server as well. (If you
don't understand this, don't worry; you probably won't encounter this don't understand this, don't worry; you probably won't encounter this
situation) situation)
MULTIPLE INSTANCES MULTIPLE INSTANCES
OfflineIMAP is not designed to have several instances (for instance, a OfflineIMAP is not designed to have several instances (for instance, a
cron job and an interactive invocation) run over the same mailbox cron job and an interactive invocation) run over the same mailbox
simultaneously. It will perform a check on startup and abort if simultaneously. It will perform a check on startup and abort if
another OfflineIMAP is already running. If you need to schedule syn- another OfflineIMAP is already running. If you need to schedule syn-
chronizations, please use the autorefresh settings rather than cron. chronizations, please use the autorefresh settings rather than cron.
Alternatively, you can set a separate metadata directory for each Alternatively, you can set a separate metadata directory for each
instance. instance.
COPYING MESSAGES BETWEEN FOLDERS COPYING MESSAGES BETWEEN FOLDERS
Normally, when you copy a message between folders or add a new message Normally, when you copy a message between folders or add a new message
to a folder locally, OfflineIMAP will just do the right thing. How- to a folder locally, OfflineIMAP will just do the right thing. How-
ever, sometimes this can be tricky -- if your IMAP server does not pro- ever, sometimes this can be tricky -- if your IMAP server does not pro-
vide the SEARCH command, or does not return something useful, vide the SEARCH command, or does not return something useful,
OfflineIMAP cannot determine the new UID of the message. So, in these OfflineIMAP cannot determine the new UID of the message. So, in these
rare instances, OfflineIMAP will upload the message to the IMAP server rare instances, OfflineIMAP will upload the message to the IMAP server
and delete it from your local folder. Then, on your next sync, the and delete it from your local folder. Then, on your next sync, the
message will be re-downloaded with the proper UID. OfflineIMAP makes message will be re-downloaded with the proper UID. OfflineIMAP makes
sure that the message was properly uploaded before deleting it, so sure that the message was properly uploaded before deleting it, so
there should be no risk of data loss. there should be no risk of data loss.
USE WITH EVOLUTION USE WITH EVOLUTION
OfflineIMAP can work with Evolution. To do so, first configure your OfflineIMAP can work with Evolution. To do so, first configure your
OfflineIMAP account to have sep = / in its configuration. Then, con- OfflineIMAP account to have sep = / in its configuration. Then, con-
figure Evolution with the "Maildir-format mail directories" server figure Evolution with the "Maildir-format mail directories" server
type. For the path, you will need to specify the name of the top-level type. For the path, you will need to specify the name of the top-level
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 with Maildirs is not compati- 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 ble with KMail. KMail cannot work in any mode other than to move all
messages out of all folders immediately, which (besides being annoying messages out of all folders immediately, which (besides being annoying
and fundamentally broken) is incompatible with OfflineIMAP. and fundamentally broken) is incompatible with OfflineIMAP.
However, I have made KMail version 3 work well with OfflineIMAP by However, I have made KMail version 3 work well with OfflineIMAP by
installing an IMAP server on my local machine, having OfflineIMAP sync installing an IMAP server on my local machine, having OfflineIMAP sync
to that, and pointing KMail at the same server. 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 Archives are available at
<URL:http://lists.complete.org/offlineimap@complete.org/>. <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.
UPGRADING TO 4.0 UPGRADING TO 4.0
If you are upgrading from a version of OfflineIMAP prior to 3.99.12, If you are upgrading from a version of OfflineIMAP prior to 3.99.12,
you will find that you will get errors when OfflineIMAP starts up you will find that you will get errors when OfflineIMAP starts up
(relating to ConfigParser or AccountHashGenerator) and the configura- (relating to ConfigParser or AccountHashGenerator) and the configura-
tion file. This is because the config file format had to change to tion file. This is because the config file format had to change to
accomodate new features in 4.0. Fortunately, it's not difficult to accommodate new features in 4.0. Fortunately, it's not difficult to
adjust it to suit. adjust it to suit.
First thing you need to do is stop any running OfflineIMAP instance, First thing you need to do is stop any running OfflineIMAP instance,
making sure first that it's synced all your mail. Then, modify your making sure first that it's synced all your mail. Then, modify your
~/.offlineimaprc file. You'll need to split up each account section ~/.offlineimaprc file. You'll need to split up each account section
(make sure that it now starts with "Account ") into two Repository sec- (make sure that it now starts with "Account ") into two Repository sec-
tions (one for the local side and another for the remote side.) See tions (one for the local side and another for the remote side.) See
the files offlineimap.conf.minimal and offlineimap.conf in the distri- the files offlineimap.conf.minimal and offlineimap.conf in the distri-
bution if you need more assistance. bution if you need more assistance.
OfflineIMAP's status directory area has also changed. Therefore, you OfflineIMAP's status directory area has also changed. Therefore, you
should delete everything in ~/.offlineimap as well as your local mail should delete everything in ~/.offlineimap as well as your local mail
folders. folders.
When you start up OfflineIMAP 4.0, it will re-download all your mail When you start up OfflineIMAP 4.0, it will re-download all your mail
from the server and then you can continue using it like normal. from the server and then you can continue using it like normal.
COPYRIGHT COPYRIGHT
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John OfflineIMAP, and this manual, are Copyright (C) 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
Free Software Foundation; either version 2 of the License, or (at your Free Software Foundation; either version 2 of the License, or (at your
option) any later version. option) any later version.
This program is distributed in the hope that it will be useful, but This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER- WITHOUT ANY WARRANTY; without even the implied warranty of MER-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details. Public License for more details.
You should have received a copy of the GNU General Public License along You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc., with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
imaplib.py comes from the Python dev tree and is licensed under the imaplib.py comes from the Python dev tree and is licensed under the
GPL-compatible PSF license as stated in the file COPYRIGHT in the GPL-compatible PSF license as stated in the file COPYRIGHT in the
OfflineIMAP distribution. OfflineIMAP distribution.
AUTHOR AUTHOR
OfflineIMAP, its libraries, documentation, and all included files, OfflineIMAP, its libraries, documentation, and all included files,
except where noted, was written by John Goerzen <jgoerzen@complete.org> except where noted, was written by John Goerzen <jgoerzen@complete.org>
and copyright is held as stated in the COPYRIGHT section. and copyright is held as stated in the COPYRIGHT section.
OfflineIMAP may be downloaded, and information found, from its homepage OfflineIMAP may be downloaded, and information found, from its homepage
via either Gopher <URL:gopher://quux.org/1/devel/offlineimap> or HTTP via either Gopher <URL:gopher://quux.org/1/devel/offlineimap> or HTTP
<URL:http://quux.org/devel/offlineimap>. <URL:http://quux.org/devel/offlineimap>.
OfflineIMAP may also be downloaded using Subversion. Additionally, the OfflineIMAP may also be downloaded using Subversion. Additionally, the
distributed tar.gz may be updated with a simple "svn update" command; distributed tar.gz may be updated with a simple "svn update" command;
it is ready to go. For information on getting OfflineIMAP with Subver- it is ready to go. For information on getting OfflineIMAP with Subver-
sion, please visit the complete.org Subversion page sion, please visit the complete.org Subversion page
<URL:http://svn.complete.org/>. <URL:http://svn.complete.org/>.
SEE ALSO SEE ALSO
mutt(1), python(1) mutt(1), python(1)
HISTORY
Detailed history may be found in the file ChangeLog in the OfflineIMAP
distribution. Feature and bug histories may be found in the file
debian/changelog which, despite its name, is not really Debian-spe-
cific. This section provides a large overview.
Development on OfflineIMAP began on June 18, 2002. Version 1.0.0 was
released three days later on June 21, 2002. Point releases followed,
including speed optimizations and some compatibility fixes.
Version 2.0.0 was released on July 3, 2002, and represented the first
time the synchronization became multithreaded and, to the best of my
knowledge, the first multithreaded IMAP syncrhonizing application in
existance. The last 2.0.x release, 2.0.8, was made on July 9.
Version 3.0.0 was released on July 11, 2002, and introduced modular
user interfaces and the first GUI interface for OfflineIMAP. This man-
ual also was introduced with 3.0.0, along with many command-line
options. Version 3.1.0 was released on July 21, adding the Noninterac-
tive user interfaces, profiling support, and several bugfixes. 3.2.0
was released on July 24, adding support for the Blinkenlights GUI
interface. OfflineIMAP entered maintenance mode for awhile, as it had
reached a feature-complete milestone in my mind.
The 3.99.x branch began in on October 7, 2002, to begin work for 4.0.
The Curses.Blinkenlights interface was added in 3.99.6, and many archi-
tectural changes were made.
4.0.0 was released on July 18, 2003, including the ability to synchro-
nize directly between two IMAP servers, the first re-architecting of
the configuration file to refine the notion of an account, and the new
Curses interface.
John Goerzen 18 July 2003 OFFLINEIMAP(1)
John Goerzen 04 June 2004 OFFLINEIMAP(1)

26
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" "25 July 2003" "John Goerzen" "OfflineIMAP Manual" .TH "OFFLINEIMAP" "1" "04 June 2004" "John Goerzen" "OfflineIMAP Manual"
.SH NAME .SH NAME
OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support
@ -83,7 +83,7 @@ methods of operation for the time being.
.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,
or your system adminstrator has done that for you, your task or your system administrator has done that for you, your task
for setting up \fBOfflineIMAP\fR for the first time is quite for setting up \fBOfflineIMAP\fR for the first time is quite
simple. You just need to set up your configuration file, make simple. You just need to set up your configuration file, make
your folder directory, and run it! your folder directory, and run it!
@ -308,7 +308,7 @@ Show summary of options.
.TP .TP
\fB-u \fIinterface\fB\fR \fB-u \fIinterface\fB\fR
Specifies an alternative user interface module Specifies an alternative user interface module
to use. This overrides the defailt specified in the to use. This overrides the default specified in the
configuration file. The pre-defined options are listed in configuration file. The pre-defined options are listed in
the User Interfaces section. the User Interfaces section.
.SH "USER INTERFACES" .SH "USER INTERFACES"
@ -375,7 +375,7 @@ is the color of a message synchronization controller thread.
.TP .TP
\fBOrange\fR \fBOrange\fR
indicates that an actual message is being copied. indicates that an actual message is being copied.
(We use fuschia for fake messages.) (We use fuchsia for fake messages.)
.TP .TP
\fBRed (meaning 2)\fR \fBRed (meaning 2)\fR
indicates that a message is being deleted. indicates that a message is being deleted.
@ -562,10 +562,14 @@ prioritized = ['INBOX', 'personal', 'announce', 'list']
def mycmp(x, y): def mycmp(x, y):
for prefix in prioritized: for prefix in prioritized:
if x.startswith(prefix): xsw = x.startswith(prefix)
return -1 ysw = y.startswith(prefix)
elif y.startswith(prefix): if xsw and ysw:
return +1 return cmp(x, y)
elif xsw:
return -1
elif ysw:
return +1
return cmp(x, y) return cmp(x, y)
def test_mycmp(): def test_mycmp():
@ -673,7 +677,7 @@ Yes; see the Notes section below.
Some mail readers, such as Mutt, are not capable Some mail readers, such as Mutt, are not capable
of automatically determining the names of your mailboxes. of automatically determining the names of your mailboxes.
\fBOfflineIMAP\fR can help these programs by writing the names \fBOfflineIMAP\fR can help these programs by writing the names
of the folders ni a format you specify. See the example of the folders in a format you specify. See the example
\fIofflineimap.conf\fR for details. \fIofflineimap.conf\fR for details.
.TP .TP
\fBCan I synchronize multiple accounts with OfflineIMAP?\fR \fBCan I synchronize multiple accounts with OfflineIMAP?\fR
@ -769,7 +773,7 @@ Standard Python 2.2.1 as implemented on POSIX-compliant systems.
.SS "DELETING LOCAL FOLDERS" .SS "DELETING LOCAL FOLDERS"
.PP .PP
\fBOfflineIMAP\fR does a two-way synchronization. That is, if you \fBOfflineIMAP\fR does a two-way synchronization. That is, if you
make a change to the mail on the server, it will be propogated to your make a change to the mail on the server, it will be propagated to your
local copy, and vise-versa. Some people might think that it would be local copy, and vise-versa. Some people might think that it would be
wise to just delete all their local mail folders periodically. If you wise to just delete all their local mail folders periodically. If you
do this with \fBOfflineIMAP\fR, remember to also remove your local status do this with \fBOfflineIMAP\fR, remember to also remove your local status
@ -846,7 +850,7 @@ If you are upgrading from a version of \fBOfflineIMAP\fR prior to
\fBOfflineIMAP\fR starts up (relating to ConfigParser or \fBOfflineIMAP\fR starts up (relating to ConfigParser or
AccountHashGenerator) and the AccountHashGenerator) and the
configuration file. This is because the config file format configuration file. This is because the config file format
had to change to accomodate new features in 4.0. Fortunately, had to change to accommodate new features in 4.0. Fortunately,
it's not difficult to adjust it to suit. it's not difficult to adjust it to suit.
.PP .PP
First thing you need to do is stop any running \fBOfflineIMAP\fR First thing you need to do is stop any running \fBOfflineIMAP\fR

2
offlineimap/head/offlineimap.conf
View File

@ -286,7 +286,7 @@ holdconnectionopen = no
# filtered out by folderfilter below. Failure to follow this rule # filtered out by folderfilter below. Failure to follow this rule
# will result in undefined behavior # will result in undefined behavior
# #
# nametrans = lambda foldername: re.sub('^INBOX.', '', foldername) # nametrans = lambda foldername: re.sub('^INBOX\.', '', foldername)
# You can specify which folders to sync. You can do it several ways. # You can specify which folders to sync. You can do it several ways.
# I'll provide some examples. The folderfilter operates on the # I'll provide some examples. The folderfilter operates on the

26
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-07-25 15:41:35 -0500 (Fri, 25 Jul 2003) $ </date> <date> $Date: 2004-06-04 10:26:30 -0500 (Fri, 04 Jun 2004) $ </date>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
@ -124,7 +124,7 @@
<refsect1> <refsect1>
<title>Quick Start</title> <title>Quick Start</title>
<para>If you have already installed &OfflineIMAP; system-wide, <para>If you have already installed &OfflineIMAP; system-wide,
or your system adminstrator has done that for you, your task or your system administrator has done that for you, your task
for setting up &OfflineIMAP; for the first time is quite for setting up &OfflineIMAP; for the first time is quite
simple. You just need to set up your configuration file, make simple. You just need to set up your configuration file, make
your folder directory, and run it! your folder directory, and run it!
@ -395,7 +395,7 @@ cd offlineimap-x.y.z</ProgramListing>
</varlistentry> </varlistentry>
<varlistentry><term>-u <replaceable>interface</replaceable></term> <varlistentry><term>-u <replaceable>interface</replaceable></term>
<listitem><para>Specifies an alternative user interface module <listitem><para>Specifies an alternative user interface module
to use. This overrides the defailt specified in the to use. This overrides the default specified in the
configuration file. The pre-defined options are listed in configuration file. The pre-defined options are listed in
the User Interfaces section.</para> the User Interfaces section.</para>
</listitem> </listitem>
@ -485,7 +485,7 @@ cd offlineimap-x.y.z</ProgramListing>
<varlistentry> <varlistentry>
<term>Orange</term> <term>Orange</term>
<listitem><para>indicates that an actual message is being copied. <listitem><para>indicates that an actual message is being copied.
(We use fuschia for fake messages.) (We use fuchsia for fake messages.)
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -709,10 +709,14 @@ foldersort=mycmp</programlisting>
def mycmp(x, y): def mycmp(x, y):
for prefix in prioritized: for prefix in prioritized:
if x.startswith(prefix): xsw = x.startswith(prefix)
return -1 ysw = y.startswith(prefix)
elif y.startswith(prefix): if xsw and ysw:
return +1 return cmp(x, y)
elif xsw:
return -1
elif ysw:
return +1
return cmp(x, y) return cmp(x, y)
def test_mycmp(): def test_mycmp():
@ -863,7 +867,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
<listitem><para>Some mail readers, such as Mutt, are not capable <listitem><para>Some mail readers, such as Mutt, are not capable
of automatically determining the names of your mailboxes. of automatically determining the names of your mailboxes.
&OfflineIMAP; can help these programs by writing the names &OfflineIMAP; can help these programs by writing the names
of the folders ni a format you specify. See the example of the folders in a format you specify. See the example
<filename>offlineimap.conf</filename> for details. <filename>offlineimap.conf</filename> for details.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
@ -962,7 +966,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
<refsect2> <refsect2>
<title>Deleting Local Folders</title> <title>Deleting Local Folders</title>
<para>&OfflineIMAP; does a two-way synchronization. That is, if you <para>&OfflineIMAP; does a two-way synchronization. That is, if you
make a change to the mail on the server, it will be propogated to your make a change to the mail on the server, it will be propagated to your
local copy, and vise-versa. Some people might think that it would be local copy, and vise-versa. Some people might think that it would be
wise to just delete all their local mail folders periodically. If you wise to just delete all their local mail folders periodically. If you
do this with &OfflineIMAP;, remember to also remove your local status do this with &OfflineIMAP;, remember to also remove your local status
@ -1065,7 +1069,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
&OfflineIMAP; starts up (relating to ConfigParser or &OfflineIMAP; starts up (relating to ConfigParser or
AccountHashGenerator) and the AccountHashGenerator) and the
configuration file. This is because the config file format configuration file. This is because the config file format
had to change to accomodate new features in 4.0. Fortunately, had to change to accommodate new features in 4.0. Fortunately,
it's not difficult to adjust it to suit. it's not difficult to adjust it to suit.
</para> </para>
<para> <para>