PIM
/
offlineimap
mirror of https://github.com/OfflineIMAP/offlineimap.git
1
0
Fork 0
Code Issues Releases Wiki Activity

/offlineimap/head: changeset 221 

Readying 3.2.3. Updated docs, version, etc.
This commit is contained in:
jgoerzen 2002-08-08 21:21:56 +01:00
parent 9cbb14f5dd
commit d9836ef791
6 changed files with 939 additions and 850 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
offlineimap/head/ChangeLog
View File

@ -1,3 +1,52 @@
------------------------------------------------------------------------
rev 220: jgoerzen | 2002-08-08 10:18:45 -0500 (Thu, 08 Aug 2002) | 2 lines
Changed paths:
U /offlineimap/head/offlineimap/repository/Maildir.py
Now logs folder names of return value when debugging.
------------------------------------------------------------------------
rev 219: jgoerzen | 2002-08-08 10:17:36 -0500 (Thu, 08 Aug 2002) | 2 lines
Changed paths:
U /offlineimap/head/offlineimap/repository/Maildir.py
Updated debugging
------------------------------------------------------------------------
rev 218: jgoerzen | 2002-08-08 10:15:30 -0500 (Thu, 08 Aug 2002) | 2 lines
Changed paths:
U /offlineimap/head/offlineimap/repository/Maildir.py
Added maildir repository debug code
------------------------------------------------------------------------
rev 217: jgoerzen | 2002-08-08 10:03:36 -0500 (Thu, 08 Aug 2002) | 4 lines
Changed paths:
U /offlineimap/head/debian/changelog
U /offlineimap/head/offlineimap/imaplib.py
U /offlineimap/head/offlineimap/repository/Maildir.py
U /offlineimap/head/offlineimap/ui/TTY.py
U /offlineimap/head/offlineimap/ui/UIBase.py
U /offlineimap/head/offlineimap.1
U /offlineimap/head/offlineimap.py
-d now takes a parameter to specify what kind of debugging to do.
imaplib now does debugging through the UI system.
UIBase now has a debugging process.
------------------------------------------------------------------------
rev 215: jgoerzen | 2002-08-07 20:28:34 -0500 (Wed, 07 Aug 2002) | 2 lines
Changed paths:
U /offlineimap/head/ChangeLog
U /offlineimap/head/debian/changelog
U /offlineimap/head/manual.html
U /offlineimap/head/manual.pdf
U /offlineimap/head/manual.ps
U /offlineimap/head/manual.txt
U /offlineimap/head/offlineimap/version.py
Readying version 3.2.2.
------------------------------------------------------------------------
rev 214: jgoerzen | 2002-08-07 17:27:55 -0500 (Wed, 07 Aug 2002) | 2 lines
Changed paths:

36
offlineimap/head/manual.html
View File

@ -26,7 +26,7 @@
<hr>
<!-- Creator : groff version 1.17.2 -->
<!-- CreationDate: Wed Aug 7 20:27:02 2002 -->
<!-- CreationDate: Thu Aug 8 10:19:22 2002 -->
<a name="NAME"></a>
<h2>NAME</h2>
<table width="100%" border=0 rules="none" frame="void"
@ -43,8 +43,9 @@ OfflineIMAP - Powerful IMAP/Maildir synchronization and reader support</td></tab
<td width="10%"></td><td width="90%">
<b>offlineimap</b> [ <b>-1</b> ] [ <b>-P</b>
<i>profiledir</i> ] [ <b>-a</b> <i>accountlist</i> ] [
<b>-c</b> <i>configfile</i> ] [ <b>-d</b> ] [ <b>-o</b> ] [
<b>-u</b> <i>interface</i> ]</td></table>
<b>-c</b> <i>configfile</i> ] [ <b>-d</b>
<i>debugtype[,debugtype...]</i> ] [ <b>-o</b> ] [ <b>-u</b>
<i>interface</i> ]</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
@ -375,20 +376,31 @@ default, <i>~/.offlineimaprc.</i></td></table>
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>-d</b></td></table>
<b>-d</b> <i>debugtype[,debugtype...]</i></td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td><td width="79%">
Enables IMAP protocol stream and parsing debugging. This is
useful if you are trying to track down a malfunction or
figure out what is going on under the hood. I suggest that
you use this with <b>-1</b> in order to make the results
more sensible. Note that this output will contain full IMAP
protocol in plain text, including passwords, so take care to
remove that from the debugging output before sending it to
anyone else.</td></table>
Enables debugging for OfflineIMAP. This is useful if you are
trying to track down a malfunction or figure out what is
going on under the hood. I suggest that you use this with
<b>-1</b> in order to make the results more
sensible.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td><td width="79%">
-d now requires one or more debugtypes, separated by commas.
These define what exactly will be debugged, and so far
include two options: <b>imap</b> and <b>maildir.</b> The
<b>imap</b> 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 <b>maildir</b>
option will enable debugging for certain Maildir
operations.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">

BIN
offlineimap/head/manual.pdf
View File

Binary file not shown.

1092
offlineimap/head/manual.ps
View File

File diff suppressed because it is too large Load Diff

536
offlineimap/head/manual.txt
View File

@ -8,111 +8,112 @@ NAME
SYNOPSIS
offlineimap [ -1 ] [ -P profiledir ] [ -a accountlist ] [
-c configfile ] [ -d ] [ -o ] [ -u interface ]
-c configfile ] [ -d debugtype[,debugtype...] ] [ -o ] [
-u interface ]
offlineimap -h | --help
DESCRIPTION
OfflineIMAP is a tool to simplify your e-mail reading.
With OfflineIMAP, you can read the same mailbox from mul-
tiple computers. You get a current copy of your messages
on each computer, and changes you make one place will be
visible on all other systems. For instance, you can
OfflineIMAP is a tool to simplify your e-mail reading.
With OfflineIMAP, you can read the same mailbox from mul-
tiple computers. You get a current copy of your messages
on each computer, and changes you make one place will be
visible on all other systems. For instance, you can
delete a message on your home computer, and it will appear
deleted on your work computer as well. OfflineIMAP is
deleted on your work computer as well. OfflineIMAP is
also useful if you want to use a mail reader that does not
have IMAP support, has poor IMAP support, or does not pro-
vide disconnected operation.
OfflineIMAP is FAST; it synchronizes my two accounts with
over 50 folders in 3 seconds. Other similar tools might
take over a minute, and achieve a less-reliable result.
Some mail readers can take over 10 minutes to do the same
thing, and some don't even support it at all. Unlike
other mail tools, OfflineIMAP features a multi-threaded
synchronization algorithm that can dramatically speed up
performance in many situations by synchronizing several
OfflineIMAP is FAST; it synchronizes my two accounts with
over 50 folders in 3 seconds. Other similar tools might
take over a minute, and achieve a less-reliable result.
Some mail readers can take over 10 minutes to do the same
thing, and some don't even support it at all. Unlike
other mail tools, OfflineIMAP features a multi-threaded
synchronization algorithm that can dramatically speed up
performance in many situations by synchronizing several
different things simultaneously.
OfflineIMAP is FLEXIBLE; you can customize which folders
are synced via regular expressions, lists, or Python
expressions; a versatile and comprehensive configuration
file is used to control behavior; two user interfaces are
built-in; fine-tuning of synchronization performance is
possible; internal or external automation is supported;
SSL and PREAUTH tunnels are both supported; offline (or
"unplugged") reading is supported; and esoteric IMAP fea-
tures are supported to ensure compatibility with the
OfflineIMAP is FLEXIBLE; you can customize which folders
are synced via regular expressions, lists, or Python
expressions; a versatile and comprehensive configuration
file is used to control behavior; two user interfaces are
built-in; fine-tuning of synchronization performance is
possible; internal or external automation is supported;
SSL and PREAUTH tunnels are both supported; offline (or
"unplugged") reading is supported; and esoteric IMAP fea-
tures are supported to ensure compatibility with the
widest variety of IMAP servers.
OfflineIMAP is SAFE; it uses an algorithm designed to pre-
vent mail loss at all costs. Because of the design of
this algorithm, even programming errors should not result
in loss of mail. I am so confident in the algorithm that
I use my own personal and work accounts for testing of
vent mail loss at all costs. Because of the design of
this algorithm, even programming errors should not result
in loss of mail. I am so confident in the algorithm that
I use my own personal and work accounts for testing of
OfflineIMAP pre-release, development, and beta releases.
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
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 com-
to the mail folders on your IMAP server and your own com-
puter and bi-directionally synchronize them, copying,
marking, and deleting messages as necessary.
INSTALLATION
If you are reading this document via the "man" command, it
is likely that you have no installation tasks to perform;
your system administrator has already installed it. If
is likely that you have no installation tasks to perform;
your system administrator has already installed it. If
you need to install it yourself, you have three options: a
system-wide installation with Debian, system-wide instal-
system-wide installation with Debian, system-wide instal-
lation with other systems, and a single-user installation.
You can download the latest version of OfflineIMAP from
You can download the latest version of OfflineIMAP from
http://quux.org/devel/offlineimap/.
PREREQUISITES
In order to use OfflineIMAP, you need to have these condi-
tions satisfied:
o Your mail server must support IMAP. Most Internet
Service Providers and corporate networks do, and
most operating systems have an IMAP implementation
o Your mail server must support IMAP. Most Internet
Service Providers and corporate networks do, and
most operating systems have an IMAP implementation
readily available.
o You must have Python version 2.2.1 or above
o You must have Python version 2.2.1 or above
installed. If you are running on Debian GNU/Linux,
this requirement will automatically be taken care
of for you. If you do not have Python already,
check with your system administrator or operating
system vendor; or, download it from
http://www.python.org/. If you intend to use the
Tk interface, you must have Tkiner (python-tk)
this requirement will automatically be taken care
of for you. If you do not have Python already,
check with your system administrator or operating
system vendor; or, download it from
http://www.python.org/. If you intend to use the
Tk interface, you must have Tkiner (python-tk)
installed. If you intend to use the SSL interface,
your Python must have been built with SSL support.
your Python must have been built with SSL support.
o Have a mail reader that supports the Maildir mail-
box format. Most modern mail readers have this
support built-in, so you can choose from a wide
o Have a mail reader that supports the Maildir mail-
box 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 compati-
as the "qmail" format, so any mail reader compati-
ble with it will work with OfflineIMAP.
DEBIAN SYSTEM-WIDE INSTALLATION
If you are tracking Debian unstable, you may install
OfflineIMAP by simply running the following command as
If you are tracking Debian unstable, you may install
OfflineIMAP by simply running the following command as
root:
apt-get install offlineimap
If you are not tracking Debian unstable, download the
Debian .deb package from the OfflineIMAP website and then
run dpkg -i to install the downloaded package. Then, go
to CONFIGURATION below. You will type offlineimap to
If you are not tracking Debian unstable, download the
Debian .deb package from the OfflineIMAP website and then
run dpkg -i to install the downloaded package. Then, go
to CONFIGURATION below. You will type offlineimap to
invoke the program.
OTHER SYSTEM-WIDE INSTALLATION
Download the tar.gz version of the package from the web-
Download the tar.gz version of the package from the web-
site. Then run these commands:
tar -zxvf offlineimap-x.y.z.tar.gz
@ -124,139 +125,146 @@ INSTALLATION
to invoke the program.
SINGLE-ACCOUNT INSTALLATION
Download the tar.gz version of the package from the web-
Download the tar.gz version of the package from the web-
site. Then run these commands:
tar -zxvf offlineimap-x.y.z.tar.gz
cd offlineimap-x.y.z
When you want to run OfflineIMAP, you will issue the cd
command as above and then type ./offlineimap; there is no
When you want to run OfflineIMAP, you will issue the cd
command as above and then type ./offlineimap; there is no
installation step necessary.
CONFIGURATION
OfflineIMAP is regulated by a configuration file that is
normally stored in ~/.offlineimaprc. OfflineIMAP ships
OfflineIMAP is regulated by a configuration file that is
normally stored in ~/.offlineimaprc. OfflineIMAP ships
with a file named offlineimap.conf that you should copy to
that location and then edit. This file is vital to proper
operation of the system; it sets everything you need to
operation of the system; it sets everything you need to
run OfflineIMAP. Full documentation for the configuration
file is included within the sample file.
OPTIONS
Most configuration is done via the configuration file.
Most configuration is done via the configuration file.
Nevertheless, there are a few options that you may set for
OfflineIMAP.
-1 Disable all multithreading operations and use
-1 Disable all multithreading operations and use
solely a single-thread sync. This effectively sets
the maxsyncaccounts and all maxconnections configu-
ration file variables to 1.
-P profiledir
Sets OfflineIMAP into profile mode. The program
Sets OfflineIMAP into profile mode. The program
will create profiledir (it must not already exist).
As it runs, Python profiling information about each
thread is logged into profiledir. Please note:
This option is present for debugging and optimiza-
thread is logged into profiledir. Please note:
This option is present for debugging and optimiza-
tion only, and should NOT be used unless you have a
specific reason to do so. It will significantly
slow program performance, may reduce reliability,
and can generate huge amounts of data. You must
specific reason to do so. It will significantly
slow program performance, may reduce reliability,
and can generate huge amounts of data. You must
use the -1 option when you use -P.
-a accountlist
Overrides the accounts section in the config file.
Lets you specify a particular account or set of
accounts to sync without having to edit the config
Overrides the accounts section in the config file.
Lets you specify a particular account or set of
accounts to sync without having to edit the config
file. You might use this to exclude certain
accounts, or to sync some accounts that you nor-
accounts, or to sync some accounts that you nor-
mally prefer not to.
-c configfile
Specifies a configuration file to use in lieu of
Specifies a configuration file to use in lieu of
the default, ~/.offlineimaprc.
-d Enables IMAP protocol stream and parsing debugging.
This is useful if you are trying to track down a
malfunction or figure out what is going on under
the hood. I suggest that you use this with -1 in
order to make the results more sensible. Note that
this output will contain full IMAP protocol in
plain text, including passwords, so take care to
remove that from the debugging output before send-
ing it to anyone else.
-d debugtype[,debugtype...]
Enables debugging for OfflineIMAP. This is useful
if you are trying to track down a malfunction or
figure out what is going on under the hood. I sug-
gest that you use this with -1 in order to make the
results more sensible.
-o Run only once, ignoring any autorefresh setting in
-d now requires one or more debugtypes, separated
by commas. These define what exactly will be
debugged, and so far 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 any-
one else. The maildir option will enable debugging
for certain Maildir operations.
-o Run only once, ignoring any autorefresh setting in
the config file.
-h, --help
Show summary of options.
-u interface
Specifies an alternative user interface module to
use. This overrides the default specified in the
configuration file. The UI specified with -u will
be forced to be used, even if its isuable() method
states that it cannot be. Use this option with
care. The pre-defined options are listed in the
Specifies an alternative user interface module to
use. This overrides the default specified in the
configuration file. The UI specified with -u will
be forced to be used, even if its isuable() method
states that it cannot be. Use this option with
care. The pre-defined options are listed in the
USER INTERFACES section.
USER INTERFACES
OfflineIMAP has a pluggable user interface system that
lets you choose how the program communicates information
to you. There are two graphical interfaces, one terminal
interface, and two noninteractive interfaces suitable for
scripting or logging purposes. The ui option in the con-
figuration file specifies the user interface preferences.
The -u command-line option can override the configuration
file. The available values for the configuration file or
OfflineIMAP has a pluggable user interface system that
lets you choose how the program communicates information
to you. There are two graphical interfaces, one terminal
interface, and two noninteractive interfaces suitable for
scripting or logging purposes. The ui option in the con-
figuration file specifies the user interface preferences.
The -u command-line option can override the configuration
file. The available values for the configuration file or
command-line are describef in this section.
Tk.Blinkenlights
This is an interface designed to be sleek, fun to watch,
This is an interface designed to be sleek, fun to watch,
and informative of the overall picture of what OfflineIMAP
is doing. I consider it to be the best general-purpose
interface in OfflineIMAP. Tk.Blinkenlights contains, by
default, a small window with a row of LEDs 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
is doing. I consider it to be the best general-purpose
interface in OfflineIMAP. Tk.Blinkenlights contains, by
default, a small window with a row of LEDs 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
functional. There is also an optional, toggable, log that
shows more detail about what is happening and is color-
shows more detail about what is happening and is color-
coded to match the color of the lights.
Tk.Blinkenlights is the only user interface that has con-
Tk.Blinkenlights is the only user interface that has con-
figurable parameters; see the example offlineimap.conf for
more details.
Each light in the Tk.Blinkenlights interface represents a
thread of execution -- that is, a particular task that
OfflineIMAP is performing right now. The color indicates
what task the particular thread is performing, and are as
Each light in the Tk.Blinkenlights interface represents a
thread of execution -- that is, a particular task that
OfflineIMAP is performing right now. The color indicates
what task the particular thread is performing, and are as
follows:
Black indicates that this light's thread has terminated;
Black indicates that this light's thread has terminated;
it will light up again later when new threads start
up. So, black indicates no activity.
Red (Meaning 1)
is the color of the main program's thread, which
basically does nothing but monitor the others. It
is the color of the main program's thread, which
basically does nothing but monitor the others. It
might remind you of HAL 9000 in 2001.
Gray indicates that the thread is establishing a new
Gray indicates that the thread is establishing a new
connection to the IMAP server.
Purple is the color of an account synchronization thread
that is monitoring the progress of the folders in
Purple is the color of an account synchronization thread
that is monitoring the progress of the folders in
that account (not generating any I/O).
Cyan indicates that the thread is syncing a folder.
Green means that a folder's message list is being loaded.
Blue is the color of a message synchronization con-
Blue is the color of a message synchronization con-
troller thread.
Orange indicates that an actual message is being copied.
@ -264,83 +272,83 @@ USER INTERFACES
Red (Meaning 2)
indicates that a message is being deleted.
Yellow (bright orange) indicates that message flags are
Yellow (bright orange) indicates that message flags are
being added.
Pink (bright red) indicates that message flags are being
removed.
Red / Black Flashing
corresponds to the countdown timer that runs
corresponds to the countdown timer that runs
between synchronizations.
The name of this interface derives from a bit of computer
The name of this interface derives from a bit of computer
science history. Eric Raymond's Jargon File defines
blinkenlights, in part, as:
Front-panel diagnostic lights on a computer, esp. a
dinosaur. Now that dinosaurs are rare, this term
dinosaur. Now that dinosaurs are rare, this term
usually refers to status lights on a modem, network
hub, or the like.
This term derives from the last word of the famous
blackletter-Gothic sign in mangled pseudo-German
that once graced about half the computer rooms in
the English-speaking world. One version ran in its
This term derives from the last word of the famous
blackletter-Gothic sign in mangled pseudo-German
that once graced about half the computer rooms in
the English-speaking world. One version ran in its
entirety as follows:
ACHTUNG! ALLES LOOKENSPEEPERS!
Das computermachine ist nicht fuer gefingerpoken
und mittengrabben. Ist easy schnappen der sprin-
genwerk, blowenfusen und poppencorken mit
spitzensparken. Ist nicht fuer gewerken bei das
dumpkopfen. Das rubbernecken sichtseeren keepen
Das computermachine ist nicht fuer gefingerpoken
und mittengrabben. Ist easy schnappen der sprin-
genwerk, blowenfusen und poppencorken mit
spitzensparken. Ist nicht fuer gewerken bei das
dumpkopfen. Das rubbernecken sichtseeren keepen
das cotten-pickenen hans in das pockets muss;
relaxen und watchen das blinkenlichten.
Tk.VerboseUI
This interface (formerly known as Tk.TkUI) is a graphical
interface that presents a variable-sized window. In the
window, each currently-executing thread has a section
where its name and current status are displayed. This
interface is best suited to people running on slower con-
This interface (formerly known as Tk.TkUI) is a graphical
interface that presents a variable-sized window. In the
window, each currently-executing thread has a section
where its name and current status are displayed. This
interface is best suited to people running on slower con-
nections, as you get a lot of detail, but for fast connec-
tions, the detail may go by too quickly to be useful.
People with fast connections may wish to use Tk.Blinken-
tions, the detail may go by too quickly to be useful.
People with fast connections may wish to use Tk.Blinken-
lights instead.
TTY.TTYUI
This interface is the default for people running in termi-
nals. It prints out basic status messages, has an inter-
ruptible timer like the graphical interfaces do, and is
nals. It prints out basic status messages, has an inter-
ruptible timer like the graphical interfaces do, and is
generally friendly to use on a console or xterm.
Noninteractive.Basic
This interface is designed for situations where
This interface is designed for situations where
OfflineIMAP 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 automatically and e-mail you the
results of the synchronization. This user interface is
not capable of reading a password from the keyboard;
account passwords must be specified using one of the con-
to have the system run automatically and e-mail you the
results of the synchronization. This user interface is
not capable of reading a password from the keyboard;
account passwords must be specified using one of the con-
figuration file options.
Noninteractive.Quiet
This interface is designed for non-attended running in
situations where normal status messages are not desired.
This interface is designed for non-attended running in
situations where normal status messages are not desired.
It will output nothing except errors and serious warnings.
Like Noninteractive.Basic, this user interface is not
capable of reading a password from the keyboard; account
Like Noninteractive.Basic, this user interface is not
capable of reading a password from the keyboard; account
passwords must be specified using one of the configuration
file options.
EXAMPLES
Here is an example configuration for a particularly com-
Here is an example configuration for a particularly com-
plex situation; more examples will be added later.
MULTIPLE ACCOUNTS WITH MUTT
This example shows you how to set up OfflineIMAP to syn-
This example shows you how to set up OfflineIMAP to syn-
chronize multiple accounts with the mutt mail reader.
Start by creating a directory to hold your folders:
@ -349,8 +357,8 @@ EXAMPLES
In your ~/.offlineimaprc, specify this:
accounts = Personal, Work
Make sure that you have both a [Personal] and a [Work]
section, with different localfolder pathnames and enable
Make sure that you have both a [Personal] and a [Work]
section, with different localfolder pathnames and enable
[mbnames].
In each account section, do something like this:
@ -367,13 +375,13 @@ EXAMPLES
That's it!
UW-IMAPD AND REFERENCES
Some users with a UW-IMAPD server need to use
OfflineIMAP's "reference" feature to get at their mail-
Some users with a UW-IMAPD server need to use
OfflineIMAP's "reference" feature to get at their mail-
boxes, 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
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.
[Gerf]
@ -400,49 +408,49 @@ ERRORS
errors, please check this section.
UID validity problem for folder
IMAP servers use a unique ID (UID) to refer to a specific
IMAP servers use a unique ID (UID) to refer to a specific
message. This number is guaranteed to be unique to a par-
ticular message FOREVER. 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
used to match up messages on your computer to messages on
ticular message FOREVER. 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
used to match up messages on your computer to messages on
the server.
Sometimes, the UIDs on the server might get reset. Usu-
ally this will 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 OfflineIMAP might still
have the UIDs from the previous folder by the same name
stored. OfflineIMAP will detect this condition and skip
the folder. This is GOOD, because it prevents data loss.
Sometimes, the UIDs on the server might get reset. Usu-
ally this will 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 OfflineIMAP might still
have the UIDs from the previous folder by the same name
stored. OfflineIMAP will detect this condition and skip
the folder. This is GOOD, because it prevents data loss.
You can fix it by removing your local folder and cache
data. For instance, if your folders are under ~/Folders
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 problem is INBOX, you'd type this:
rm -r ~/Folders/INBOX
rm ~/.offlineimap/AccountName/INBOX
(replacing AccountName with the account name as specified
(replacing AccountName with the account name as specified
in ~/.offlineimaprc)
Next time you run OfflineIMAP, it will re-download the
folder with the new UIDs. Note that the procedure speci-
Next time you run OfflineIMAP, it will re-download the
folder with the new UIDs. Note that the procedure speci-
fied above will lose any local changes made to the folder.
Some IMAP servers are broken and do not support UIDs prop-
erly. If you 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 category.
OfflineIMAP is incompatible with such servers. Using
OfflineIMAP with them will not destroy any mail, but at
erly. If you 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 category.
OfflineIMAP is incompatible with such servers. Using
OfflineIMAP with them will not destroy any mail, but at
the same time, it will not actually synchronize it either.
(OfflineIMAP will detect this condition and abort prior to
synchronization)
OTHER FREQUENTLY ASKED QUESTIONS
There are some other FAQs that might not fit into another
There are some other FAQs that might not fit into another
section of this document, and they are enumerated here.
What platforms does OfflineIMAP run on?
@ -453,96 +461,96 @@ OTHER FREQUENTLY ASKED QUESTIONS
set maildir_trash=yes . Do I need to do that with
OfflineIMAP?
No. OfflineIMAP is smart enough to figure out mes-
sage deletion without this extra crutch. You'll
sage deletion without this extra crutch. You'll
get the best results if you don't use this setting,
in fact.
How do I specify the names of my folders?
You do not need to. OfflineIMAP is smart enough to
automatically figure out what folders are present
on the IMAP server and synchronize them. You can
use the folderfilter and foldertrans configuration
file options to request certain folders and rename
automatically figure out what folders are present
on the IMAP server and synchronize them. You can
use the folderfilter and foldertrans configuration
file options to request certain folders and rename
them as they come in if you like.
How can I prevent certain folders from being synced?
Use the folderfilter option in the configuration
Use the folderfilter option in the configuration
file.
How can I add or delete a folder?
OfflineIMAP does not currently provide this fea-
ture, but if you create a new folder on the IMAP
OfflineIMAP does not currently provide this fea-
ture, but if you create a new folder on the IMAP
server, it will be created locally automatically.
Are there any other warnings that I should be aware of?
Yes; see the NOTES section below.
What is the mailbox name recorder (mbnames) for?
The Mutt mail reader is not capable of automati-
cally determining the names of your mailboxes.
OfflineIMAP can help it (or many other) programs
out be writing these names out in a format you
The Mutt mail reader is not capable of automati-
cally determining the names of your mailboxes.
OfflineIMAP can help it (or many other) programs
out be writing these names out in a format you
specify. See the example offlineimap.conf file for
details.
Can I synchronize multiple accounts with OfflineIMAP?
Sure. Just name them all in the accounts line in
the general section of the config file, and add a
Sure. Just name them all in the accounts line in
the general section of the config file, and add a
per-account section for each one.
Does OfflineIMAP support POP?
No. POP is not robust enough to do a completely
reliable multi-machine synchronization like
OfflineIMAP can do. OfflineIMAP will not support
No. POP is not robust enough to do a completely
reliable multi-machine synchronization like
OfflineIMAP can do. OfflineIMAP will not support
it.
Do you support mailbox formats other than Maildir?
Not at present. There is no technical reason not
Not at present. There is no technical reason not
to; just no demand yet. Maildir is a superior for-
mat anyway.
[technical] Why are your Maildir message filenames so
[technical] Why are your Maildir message filenames so
huge?
OfflineIMAP has two relevant principles: 1) never
modifying your messages in any way and 2) ensuring
100% reliable synchronizations. In order to do a
reliable sync, OfflineIMAP must have a way to
uniquely identify each e-mail. Three pieces of
information are required to do this: your account
name, the folder name, and the message UID. The
account name can be calculated from the path in
which your messages are. The folder name can usu-
ally be as well, BUT some mail clients move mes-
sages between folders by simply moving the file,
OfflineIMAP has two relevant principles: 1) never
modifying your messages in any way and 2) ensuring
100% reliable synchronizations. In order to do a
reliable sync, OfflineIMAP must have a way to
uniquely identify each e-mail. Three pieces of
information are required to do this: your account
name, the folder name, and the message UID. The
account name can be calculated from the path in
which your messages are. The folder name can usu-
ally be as well, BUT some mail clients move mes-
sages between folders by simply moving the file,
leaving the name intact.
So, OfflineIMAP must store both a UID folder ID.
The folder ID is necessary so OfflineIMAP can
detect a message moved to a different folder.
OfflineIMAP stores the UID (U= number) and an
md5sum of the foldername (FMD5= number) to facili-
So, OfflineIMAP must store both a UID folder ID.
The folder ID is necessary so OfflineIMAP can
detect a message moved to a different folder.
OfflineIMAP stores the UID (U= number) and an
md5sum of the foldername (FMD5= number) to facili-
tate this.
What is the speed of OfflineIMAP's sync?
OfflineIMAP versions 2.0 and above contain a multi-
threaded system. A good way to experiment is by
setting maxsyncaccounts to 3 and maxconnections to
threaded system. A good way to experiment is by
setting maxsyncaccounts to 3 and maxconnections to
3 in each account clause.
This lets OfflineIMAP open up multiple connections
simultaneously. That will let it process multiple
folders and messages at once. In most cases, this
This lets OfflineIMAP open up multiple connections
simultaneously. That will let it process multiple
folders and messages at once. In most cases, this
will increase performance of the sync.
Don't set the number too high. If you do that,
things might actually slow down as your link gets
saturated. Also, too many connections can cause
mail servers to have excessive load. Administra-
tors might take unkindly to this, and the server
might bog down. There are many variables in the
Don't set the number too high. If you do that,
things might actually slow down as your link gets
saturated. Also, too many connections can cause
mail servers to have excessive load. Administra-
tors might take unkindly to this, and the server
might bog down. There are many variables in the
optimal setting; experimentation may help.
An informal benchmark yields these results for my
An informal benchmark yields these results for my
setup:
10 minutes with MacOS X Mail.app "manual cache"
@ -560,19 +568,19 @@ CONFORMING TO
manual-html/man5/maildir.html and
http://cr.yp.to/proto/maildir.html.
o Standard Python 2.2.1 as implemented on POSIX-com-
o Standard Python 2.2.1 as implemented on POSIX-com-
pliant systems.
NOTES
DELETING LOCAL FOLDERS
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 copy, and vise-versa. Some peo-
ple might think that it would be wise to just delete all
their local mail folders periodically. If you do this
with OfflineIMAP, remember to also remove your local sta-
tus cache (~/.offlineimap by default). Otherwise,
OfflineIMAP will take this as an intentional deletion of
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 copy, and vise-versa. Some peo-
ple might think that it would be wise to just delete all
their local mail folders periodically. If you do this
with OfflineIMAP, remember to also remove your local sta-
tus cache (~/.offlineimap by default). Otherwise,
OfflineIMAP will take this as an intentional deletion of
many messages and will interpret your action 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
@ -580,49 +588,49 @@ NOTES
COPYING MESSAGES BETWEEN FOLDERS
Normally, when you copy a message between folders or add a
new message to a folder locally, OfflineIMAP will just do
new message to a folder locally, OfflineIMAP will just do
the right thing. However, sometimes this can be tricky --
if your IMAP server does not provide the SEARCH command,
or does not return something useful, OfflineIMAP cannot
determine the new UID of the message. So, in these rare
if your IMAP server does not provide the SEARCH command,
or does not return something useful, OfflineIMAP cannot
determine the new UID of the message. So, in these rare
instances, OfflineIMAP will upload the message to the IMAP
server and delete it from your local folder. Then, on
server and delete it from your local folder. Then, on
your next sync, the message will be re-downloaded with the
proper UID. OfflineIMAP makes sure that the message was
properly uploaded before deleting it, so there should be
proper UID. OfflineIMAP makes sure that the message was
properly uploaded before deleting it, so there should be
no risk of data loss.
MAILING LIST
There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of
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.
BUGS
Reports of bugs should be sent via e-mail to the
OfflineIMAP bug-tracking system (BTS) at
offlineimap@bugs.complete.org or submitted on-line using
the Web interface at http://bugs.complete.org/. The Web
site also lists all current bugs, where you can check
Reports of bugs should be sent via e-mail to the
OfflineIMAP bug-tracking system (BTS) at
offlineimap@bugs.complete.org or submitted on-line using
the Web interface at http://bugs.complete.org/. The Web
site also lists all current bugs, where you can check
their status or contribute to fixing them.
COPYRIGHT
OfflineIMAP is Copyright (C) 2002 John Goerzen.
This program is free software; you can redistribute 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 Free Software Foundation;
either version 2 of the License, or (at your option) any
License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any
later version.
This program is distributed in the hope that it will be
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public
You should have received a copy of the GNU General Public
License along with this program; if not, write to:
Free Software Foundation, Inc.
@ -632,9 +640,9 @@ COPYRIGHT
USA
AUTHOR
OfflineIMAP, its libraries, documentation, and all
included files, except where noted, was written by John
Goerzen <jgoerzen@complete.org> and copyright is held as
OfflineIMAP, its libraries, documentation, and all
included files, except where noted, was written by John
Goerzen <jgoerzen@complete.org> and copyright is held as
stated in the COPYRIGHT section.
OfflineIMAP may be downloaded, and information found, from
@ -645,7 +653,7 @@ AUTHOR
OfflineIMAP may also be downloaded using Subversion.
Additionally, the distributed tar.gz may be updated with a
simple "svn update" command; it is ready to go. For
simple "svn update" command; it is ready to go. For
information on getting OfflineIMAP with Subversion, please
visit:

76
offlineimap/head/offlineimap/version.py
View File

@ -1,8 +1,8 @@
productname = 'OfflineIMAP'
versionstr = "3.2.2"
revno = long('$Rev: 215 $'[6:-2])
revno = long('$Rev: 221 $'[6:-2])
revstr = "Rev %d" % revno
datestr = '$Date: 2002-08-07 20:28:34 -0500 (Wed, 07 Aug 2002) $'
datestr = '$Date: 2002-08-08 10:21:56 -0500 (Thu, 08 Aug 2002) $'
versionlist = versionstr.split(".")
@ -41,67 +41,71 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA"""
cmdhelp = """
offlineimap [ -1 ] [ -P profiledir ] [ -a accountlist ] [
-c configfile ] [ -d ] [ -o ] [ -u interface ]
-c configfile ] [ -d debugtype[,debugtype...] ] [ -o ] [
-u interface ]
offlineimap -h | --help
-1 Disable all multithreading operations and use
-1 Disable all multithreading operations and use
solely a single-thread sync. This effectively sets
the maxsyncaccounts and all maxconnections configu-
ration file variables to 1.
-P profiledir
Sets OfflineIMAP into profile mode. The program
Sets OfflineIMAP into profile mode. The program
will create profiledir (it must not already exist).
As it runs, Python profiling information about each
thread is logged into profiledir. Please note:
This option is present for debugging and optimiza-
thread is logged into profiledir. Please note:
This option is present for debugging and optimiza-
tion only, and should NOT be used unless you have a
specific reason to do so. It will significantly
slow program performance, may reduce reliability,
and can generate huge amounts of data. You must
specific reason to do so. It will significantly
slow program performance, may reduce reliability,
and can generate huge amounts of data. You must
use the -1 option when you use -P.
-a accountlist
Overrides the accounts section in the config file.
Lets you specify a particular account or set of
accounts to sync without having to edit the config
Overrides the accounts section in the config file.
Lets you specify a particular account or set of
accounts to sync without having to edit the config
file. You might use this to exclude certain
accounts, or to sync some accounts that you nor-
accounts, or to sync some accounts that you nor-
mally prefer not to.
-c configfile
Specifies a configuration file to use in lieu of
Specifies a configuration file to use in lieu of
the default, ~/.offlineimaprc.
-d Enables IMAP protocol stream and parsing debugging.
This is useful if you are trying to track down a
malfunction or figure out what is going on under
the hood. I suggest that you use this with -1 in
order to make the results more sensible. Note that
this output will contain full IMAP protocol in
plain text, including passwords, so take care to
remove that from the debugging output before send-
ing it to anyone else.
-d debugtype[,debugtype...]
Enables debugging for OfflineIMAP. This is useful
if you are trying to track down a malfunction or
figure out what is going on under the hood. I sug-
gest that you use this with -1 in order to make the
results more sensible.
-o Run only once, ignoring any autorefresh setting in
-d now requires one or more debugtypes, separated
by commas. These define what exactly will be
debugged, and so far 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 any-
one else. The maildir option will enable debugging
for certain Maildir operations.
-o Run only once, ignoring any autorefresh setting in
the config file.
-h, --help
Show summary of options.
-u interface
Specifies an alternative user interface module to
use. This overrides the default specified in the
configuration file. The UI specified with -u will
be forced to be used, even if its isuable() method
states that it cannot be. Use this option with
care.
Specifies an alternative user interface module to
use. This overrides the default specified in the
configuration file. The UI specified with -u will
be forced to be used, even if its isuable() method
states that it cannot be. Use this option with
care. The pre-defined options are listed in the
USER INTERFACES section.
The pre-defined options are Tk.TKUI (a graphical
interface), TTY.TTYUI (a text-mode interface), Non-
interactive.Basic (a non-interactive mode suitable
for cronning), and Noninteractive.Quiet (a mode
that generates no output except for errors).
"""