From d64138c2286485f6eee4b553851b934625e0699d Mon Sep 17 00:00:00 2001
From: jgoerzen
Date: Sat, 2 Nov 2002 23:30:41 +0100
Subject: [PATCH] /offlineimap/head: changeset 276
Updated
---
offlineimap/head/bin/offlineimap | 2 +-
offlineimap/head/debian/changelog | 9 +-
offlineimap/head/manual.html | 2235 ++++++++++----------
offlineimap/head/manual.pdf | Bin 62289 -> 59442 bytes
offlineimap/head/manual.ps | 269 +--
offlineimap/head/manual.txt | 796 ++++---
offlineimap/head/offlineimap.1 | 2 +
offlineimap/head/offlineimap.py | 2 +-
offlineimap/head/offlineimap/imapserver.py | 19 +-
offlineimap/head/offlineimap/version.py | 6 +-
10 files changed, 1694 insertions(+), 1646 deletions(-)
diff --git a/offlineimap/head/bin/offlineimap b/offlineimap/head/bin/offlineimap
index 37c2ed2..ef31f04 100644
--- a/offlineimap/head/bin/offlineimap
+++ b/offlineimap/head/bin/offlineimap
@@ -18,4 +18,4 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
from offlineimap import init
-init.startup('3.99.1')
+init.startup('3.99.2')
diff --git a/offlineimap/head/debian/changelog b/offlineimap/head/debian/changelog
index cfc376c..6701715 100644
--- a/offlineimap/head/debian/changelog
+++ b/offlineimap/head/debian/changelog
@@ -6,8 +6,15 @@ offlineimap (3.99.2) unstable; urgency=low
session. This way, even unexpected and non-repeatable errors stand
a chance of getting a more detailed log.
* Handle uidvalidity file in an atomic fashion. CLoses: #165600.
+ * Supports CRAM-MD5 authentication. Fixes [complete.org #38], and for
+ Debian, Closes: #154165.
+ * Noted CRAM-MD5 support in the "CONFORMING TO" section of the manual.
+ * Certain servers may not always return the UID flag for new messages.
+ This causes an OfflineIMAP exception, though rerunning will fix it.
+ Now, OfflineIMAP will detect the condition and ignore the offending
+ messages (without an exception) until the next sync.
- -- John Goerzen Tue, 15 Oct 2002 12:35:42 -0500
+ -- John Goerzen Sat, 02 Nov 2002 10:23:10 -0600
offlineimap (3.99.1) unstable; urgency=low
diff --git a/offlineimap/head/manual.html b/offlineimap/head/manual.html
index 3dd17e2..fdfcc39 100644
--- a/offlineimap/head/manual.html
+++ b/offlineimap/head/manual.html
@@ -25,41 +25,47 @@
SEE ALSO
-
-
+
+
NAME
-
+
- |
-OfflineIMAP - Powerful IMAP/Maildir synchronization and reader support |
+ |
+
+ OfflineIMAP − Powerful IMAP/Maildir synchronization
+and reader support
+ |
+
+ |
+
+ •
+ |
+ |
+
+
+ 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.
+ |
+
+
+
+
+ |
+
+ DEBIAN SYSTEM-WIDE INSTALLATION |
+
+
- |
-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. |
-
-
-
- |
-DEBIAN SYSTEM-WIDE INSTALLATION |
-
-
-
- |
-If you are tracking Debian unstable, you may install
+ | |
+
+ If you are tracking Debian unstable, you may install
OfflineIMAP by simply running the following command
-as root: |
-
+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 invoke the program.
+
+
+
+
+
+ |
+
+ OTHER SYSTEM-WIDE INSTALLATION |
+
+
- |
-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
-invoke the program. |
-
-
-
- |
-OTHER SYSTEM-WIDE INSTALLATION |
-
-
-
- |
-Download the tar.gz version of the package from the website.
-Then run these commands: |
-
-
-
- |
-tar -zxvf offlineimap-x.y.z.tar.gz
+ | |
+
+ Download the tar.gz version of the package from the
+website. Then run these commands:
+
+tar -zxvf offlineimap-x.y.z.tar.gz
cd offlineimap-x.y.z
-python2.2 setup.py |
-
-
-
- |
-Some systems will need to use python instead of
+python2.2 setup.py
+
+ Some systems will need to use python instead of
python2.2. Next, proceed to configuration. You will
-type offlineimap to invoke the program. |
-
+type offlineimap to invoke the program.
+
+
+
+
+
+ |
+
+ SINGLE-ACCOUNT INSTALLATION |
+
+
- |
-SINGLE-ACCOUNT INSTALLATION |
-
-
-
- |
-Download the tar.gz version of the package from the website.
-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 installation step
-necessary. |
+ |
+
+ Download the tar.gz version of the package from the
+website. 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.py; there is no installation step
+necessary.
+ |
+
CONFIGURATION
-
-
+
- |
-OfflineIMAP is regulated by a configuration file that
-is normally stored in ~/.offlineimaprc.
+ | |
+
+ 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 run
OfflineIMAP. Full documentation for the configuration
-file is included within the sample file. |
+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. |
-
-
+
+
+ |
+
-
-
- |
-Disable all multithreading operations and use solely a
+ −1
+ |
+ |
+
+
+ Disable all multithreading operations and use solely a
single-thread sync. This effectively sets the
maxsyncaccounts and all maxconnections
-configuration file variables to 1. |
-
+configuration file variables to 1.
+ |
+
+
+
+
-
-
-
- |
-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 optimization only, and should NOT be used
-unless you have a specific reason to do so. It will
+ | |
+
+ 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 optimization only, and should NOT
+be used unless you have a specific reason to do so. It will
significantly slow program performance, may reduce
reliability, and can generate huge amounts of data. You must
-use the -1 option when you use
--P. |
-
+use the −1 option when you use -P.
+
+
+
+
+
-
-
-
- |
-Overrides the accounts section in the config file.
+ | |
+
+ 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 normally prefer not to. |
-
+that you normally prefer not to.
+
+
+
+
+
-
+ |
+
+ Specifies a configuration file to use in lieu of the
+default, ~/.offlineimaprc.
+ |
+
+
+
+
+ |
+
+ −d debugtype[,debugtype...] |
+
+
- |
-Specifies a configuration file to use in lieu of the
-default, ~/.offlineimaprc. |
-
-
-
- |
--d debugtype[,debugtype...] |
-
-
-
- |
-Enables debugging for OfflineIMAP. This is useful if you are
-trying to track down a malfunction or figure out what is
+ | |
+
+ 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
--1 in order to make the results more
-sensible. |
-
-−1 in order to make the results more
+sensible.
+
+
+
+
- |
--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
+ | |
+
+ -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 anyone else. The maildir
option will enable debugging for certain Maildir
-operations. |
+operations.
+
+
+
+
+
+ |
+
+ −o
+ |
+ |
+
+
+ Run only once, ignoring any autorefresh setting in the
+config file.
+ |
+
+
+
+
-
+ |
+
+ Show summary of options.
+ |
+
+
+
+
- |
-Run only once, ignoring any autorefresh setting in the
-config file. |
-
-
-
-
-
- |
-Show summary of options. |
-
-
-
-
-
- |
-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. |
+ |
+
+ 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
+ | |
+
+ 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 configuration 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. |
-
+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, and
-informative of the overall picture of what
+ | |
+
+ 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
@@ -480,396 +546,395 @@ 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-coded to match the color of the
-lights. |
-
-
-
- |
-Tk.Blinkenlights is the only user interface that has
+and is color-coded to match the color of the lights.
+
+ Tk.Blinkenlights is the only user interface that has
configurable parameters; see the example
-offlineimap.conf for more details. |
-
-
-
- |
-Each light in the Tk.Blinkenlights interface represents a
+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 follows: |
+are as follows:
+
+
+
+
+
+ |
+
+ 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.
+ |
+
+
+
+
+ |
+
+ 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
+connection to the IMAP server.
+ |
+
+ |
+
+
+ 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 controller
+thread.
+ |
+
+ |
+
+
+ Orange
+ |
+
+
+ indicates that an actual message is being copied.
+ |
+
+
+
+
- |
-indicates that this light's thread has terminated; it will
-light up again later when new threads start up. So, black
-indicates no activity. |
+ |
+
+ indicates that a message is being deleted.
+ |
+
+
+
+
+ |
+
+ 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 between
+synchronizations.
+ |
+
+
+
- |
-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. |
-
-
+
+ The name of this interface derives from a bit of computer
+science history. Eric Raymond’s Jargon File
+defines blinkenlights, in part, as:
+ |
+
+
+
-
-
-
- |
-indicates that the thread is establishing a new connection
-to the IMAP server. |
-
-
-
-
-
- |
-is the color of an account synchronization thread that is
-monitoring the progress of the folders in that account (not
-generating any I/O). |
-
-
-
-
-
- |
-indicates that the thread is syncing a folder. |
-
-
-
-
-
- |
-means that a folder's message list is being
-loaded. |
-
-
-
-
-
- |
-is the color of a message synchronization controller
-thread. |
-
-
-
-
-
- |
-indicates that an actual message is being
-copied. |
-
-
-
-
-
- |
-indicates that a message is being deleted. |
-
-
-
-
-
- |
-(bright orange) indicates that message flags are being
-added. |
-
-
-
-
-
- |
-(bright red) indicates that message flags are being
-removed. |
-
-
-
- |
-Red / Black Flashing |
-
-
-
- |
-corresponds to the countdown timer that runs between
-synchronizations. |
-
-
-
- |
-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
+ | |
+
+ Front-panel diagnostic lights on a computer, esp. a
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
+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 entirety as
-follows: |
-
-
-
- |
-ACHTUNG! ALLES LOOKENSPEEPERS! |
-
-
-
- |
-Das computermachine ist nicht fuer gefingerpoken und
+world. One version ran in its entirety as follows:
+
+ ACHTUNG! ALLES LOOKENSPEEPERS!
+
+Das computermachine ist nicht fuer gefingerpoken und
mittengrabben. Ist easy schnappen der springenwerk,
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. |
-
+muss; relaxen und watchen das blinkenlichten.
+
+
+
+
+
-
-
-
- |
-This interface (formerly known as Tk.TkUI) is a graphical
+ | |
+
+ 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 connections, as you
get a lot of detail, but for fast connections, the detail
may go by too quickly to be useful. People with fast
-connections may wish to use Tk.Blinkenlights
-instead. |
-
+connections may wish to use Tk.Blinkenlights instead.
+
+
+
+
+
-
-
-
- |
-This interface is the default for people running in
+ | |
+
+ This interface is the default for people running in
terminals. It prints out basic status messages, has an
interruptible timer like the graphical interfaces do, and is
-generally friendly to use on a console or
-xterm. |
-
+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
-configuration file options. |
-
+configuration file options.
+
+
+
+
+
+ |
+
+ Noninteractive.Quiet |
+
+
-
-
-
- |
-This interface is designed for non-attended running in
+ | |
+
+ 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 passwords must
be specified using one of the configuration file
-options. |
+options.
+
+
EXAMPLES
-
+
+
+
+ |
+
+ Here is an example configuration for a particularly
+complex situation; more examples will be added later.
+ |
+
+
+
+
+ |
+
+ MULTIPLE ACCOUNTS WITH MUTT |
+
+
- |
-Here is an example configuration for a particularly complex
-situation; more examples will be added later. |
-
-
-
- |
-MULTIPLE ACCOUNTS WITH MUTT |
-
-
-
- |
-This example shows you how to set up OfflineIMAP to
-synchronize multiple accounts with the mutt mail
-reader. |
-
-
-
- |
-Start by creating a directory to hold your folders:
-mkdir ~/Mail |
-
-
-
- |
-In your ~/.offlineimaprc, specify this:
-accounts = Personal, Work |
-
-
-
- |
-Make sure that you have both a [Personal] and a
+ | |
+
+ This example shows you how to set up OfflineIMAP
+to synchronize multiple accounts with the mutt mail
+reader.
+
+Start by creating a directory to hold your
+folders:
+mkdir ~/Mail
+
+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 [mbnames]. |
-
-
-
- |
-In each account section, do something like this:
-localfolders = ~/Mail/Personal |
-
-
-
- |
-Add these lines to your ~/.muttrc:
+and enable [mbnames].
+
+In each account section, do something like this:
+localfolders = ~/Mail/Personal
+
+Add these lines to your ~/.muttrc:
source ~/path-to-mbnames-muttrc-mailboxes
folder-hook Personal set
from="youremail@personal.com"
folder-hook Work set from="youremail@work.com"
set mbox_type=Maildir
set folder=$HOME/Mail
-set spoolfile=+Personal/INBOX |
-
+set spoolfile=+Personal/INBOX
+
+That’s it!
+
+
+
+
+
+ |
+
+ UW-IMAPD AND REFERENCES |
+
+
-
-
-
- |
-UW-IMAPD AND REFERENCES |
-
-
-
- |
-Some users with a UW-IMAPD server need to use
-OfflineIMAP's "reference" feature to get at
-their mailboxes, specifying a reference of
+ | |
+
+ 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. |
-
-
-
- |
-[Gerf]
+that limits the folders synced to just three.
+
+[Gerf]
localfolders = ~/Mail
remotehost = gerf.org
ssl = yes
@@ -877,171 +942,131 @@ remoteuser = docwhat
reference = Mail
# Trims off the preceeding Mail on all the folder names.
nametrans = lambda foldername: \
-re.sub('^Mail/', '', foldername)
+re.sub(’^Mail/’, ’’, foldername)
# Yeah, you have to mention the Mail dir, even though it
# would seem intuitive that reference would trim it.
folderfilter = lambda foldername: foldername in [
-'Mail/INBOX',
-'Mail/list/zaurus-general',
-'Mail/list/zaurus-dev',
+’Mail/INBOX’,
+’Mail/list/zaurus-general’,
+’Mail/list/zaurus-dev’,
]
maxconnections = 1
-holdconnectionopen = no |
-
+holdconnectionopen = no
+
+
+
+
+
+ |
+
+ PYTHONFILE CONFIGURATION FILE OPTION |
+
+
- |
-PYTHONFILE CONFIGURATION FILE OPTION |
-
-
-
- |
-You can have OfflineIMAP load up a Python file before
+ | |
+
+ You can have OfflineIMAP load up a Python file before
evaluating the configuration file options that are Python
expressions. This example is based on one supplied by Tommi
-Virtanen for this feature. |
-
-
-
- |
-In ~/.offlineimap.rc, he adds these
-options: |
-
-
-
- |
-[general]
+Virtanen for this feature.
+
+In ~/.offlineimap.rc, he adds these options:
+
+[general]
pythonfile=~/.offlineimap.py
[foo]
-foldersort=mycmp |
-
-
-
- |
-Then, the ~/.offlineimap.py file will
-contain: |
-
-
-
- |
-prioritized = ['INBOX', 'personal', 'announce',
-'list'] |
-
-
-
- |
-def mycmp(x, y):
+foldersort=mycmp
+
+Then, the ~/.offlineimap.py file will contain:
+
+prioritized = [’INBOX’,
+’personal’, ’announce’,
+’list’]
+
+def mycmp(x, y):
for prefix in prioritized:
if x.startswith(prefix):
return -1
elif y.startswith(prefix):
return +1
-return cmp(x, y) |
-
-
-
- |
-def test_mycmp():
+return cmp(x, y)
+
+def test_mycmp():
import os, os.path
-folders=os.listdir(os.path.expanduser('~/data/mail/tv@hq.yok.utu.fi'))
+folders=os.listdir(os.path.expanduser(’~/data/mail/tv@hq.yok.utu.fi’))
folders.sort(mycmp)
-print folders |
-
-
-
- |
-This code snippet illustrates how the foldersort
+print folders
+
+ This code snippet illustrates how the foldersort
option can be customized with a Python function from the
pythonfile to always synchronize certain folders
-first. |
+first.
+
+
ERRORS
-
+
+
+
+ |
+
+ If you get one of some frequently-encountered or
+confusing errors, please check this section.
+ |
+
+
+
+
+ |
+
+ UID validity problem for folder |
+
+
- |
-If you get one of some frequently-encountered or confusing
-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
particular 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. Usually
-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 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 in
-~/.offlineimaprc) |
-
-
-
- |
-Next time you run OfflineIMAP, it will re-download
+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.
+Usually 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 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
+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 changes made to the
-folder. |
-
-
-
- |
-Some IMAP servers are broken and do not support UIDs
+folder.
+
+ Some IMAP servers are broken and do not support UIDs
properly. If you continue to get this error for all your
folders even after performing the above procedure, it is
likely that your IMAP server falls into this category.
@@ -1049,179 +1074,235 @@ likely that your IMAP server falls into this category.
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) |
+prior to synchronization)
+
+
OTHER FREQUENTLY ASKED QUESTIONS
-
+
+
+
+ |
+
+ 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? |
+
+
- |
-There are some other FAQs that might not fit into another
-section of this document, and they are enumerated
-here. |
-
+ |
+
+ It should run on most platforms supported by Python,
+which are quite a few.
+ |
+
+
+
+
+ |
+
+ I’m using Mutt. Other IMAP sync programs require
+me to use set maildir_trash=yes . Do I need to do that with
+OfflineIMAP? |
+
+
- |
-What platforms does OfflineIMAP run on? |
-
+ |
+
+ No. OfflineIMAP is smart enough to figure out
+message 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? |
+
+
- |
-It should run on most platforms supported by Python, which
-are quite a few. |
-
-
-
- |
-I'm using Mutt. Other IMAP sync programs require me to
-use set maildir_trash=yes . Do I need to do that with
-OfflineIMAP? |
-
-
-
- |
-No. OfflineIMAP is smart enough to figure out message
-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
+ | |
+
+ 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 them as
-they come in if you like. |
-
+they come in if you like.
+
+
+
+
+
+ |
+
+ How can I prevent certain folders from being
+synced? |
+
+
- |
-How can I prevent certain folders from being
-synced? |
-
+ |
+
+ Use the folderfilter option in the configuration
+file.
+ |
+
+
+
+
+ |
+
+ How can I add or delete a folder? |
+
+
- |
-Use the folderfilter option in the configuration
-file. |
-
+ |
+
+ OfflineIMAP does not currently provide this
+feature, 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? |
+
+
- |
-How can I add or delete a folder? |
-
+ |
+
+ Yes; see the NOTES section below.
+ |
+
+
+
+
+ |
+
+ What is the mailbox name recorder (mbnames)
+for? |
+
+
- |
-OfflineIMAP does not currently provide this feature,
-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 automatically
+ | |
+
+ The Mutt mail reader is not capable of automatically
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. |
-
+offlineimap.conf file for details.
+
+
+
+
+
+ |
+
+ Can I synchronize multiple accounts with
+OfflineIMAP? |
+
+
- |
-Can I synchronize multiple accounts with
-OfflineIMAP? |
-
+ |
+
+ Sure. Just name them all in the accounts line in the
+general section of the config file, and add a per-account
+section for each one.
+ |
+
+
+
+
+ |
+
+ Does OfflineIMAP support POP? |
+
+
- |
-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
+ | |
+
+ No. POP is not robust enough to do a completely reliable
multi-machine synchronization like OfflineIMAP can do.
-OfflineIMAP will not support it. |
-
+OfflineIMAP will not support it.
+
+
+
+
+
+ |
+
+ Do you support mailbox formats other than
+Maildir? |
+
+
- |
-Do you 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.
+ |
+
+
+
+
+ |
+
+ [technical] Why are your Maildir message filenames so
+huge? |
+
+
- |
-Not at present. There is no technical reason not to; just no
-demand yet. Maildir is a superior format
-anyway. |
-
-
-
- |
-[technical] Why are your Maildir message filenames so
-huge? |
-
-
-
- |
-OfflineIMAP has two relevant principles: 1) never
+ | |
+
+ 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
@@ -1230,134 +1311,178 @@ 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 usually be as well, BUT
some mail clients move messages 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
+ | |
+
+ 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 facilitate this. |
-
+(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
+ | |
+
+ OfflineIMAP versions 2.0 and above contain a
multithreaded 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
+ | |
+
+ 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. Administrators 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
-setup: |
-
-
-
- |
-10 minutes with MacOS X Mail.app "manual
+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. Administrators 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
+setup:
+
+10 minutes with MacOS X Mail.app "manual
cache"
5 minutes with GNUS agent sync
20 seconds with OfflineIMAP 1.x
9 seconds with OfflineIMAP 2.x
3 seconds with OfflineIMAP 3.x "cold start"
2 seconds with OfflineIMAP 3.x "held
-connection" |
+connection"
+
+
CONFORMING TO
-
-
+
+
- |
-Internet Message Access Protocol version 4rev1 (IMAP 4rev1)
-as specified in RFC2060 |
+ |
+
-
+•
+
+ |
+
+
+ Internet Message Access Protocol version 4rev1 (IMAP
+4rev1) as specified in RFC2060
+ |
- |
-Maildir as specified in
+ | |
+
+
+ •
+ |
+ |
+
+
+ CRAM-MD5 as specified in RFC2195
+ |
+
+
+
+
+ |
+
+
+ •
+ |
+ |
+
+
+ Maildir as specified in
http://www.qmail.org/qmail-manual-html/man5/maildir.html and
-http://cr.yp.to/proto/maildir.html. |
-
-
+http://cr.yp.to/proto/maildir.html.
+
- |
-Standard Python 2.2.1 as implemented on POSIX-compliant
-systems. |
+ | |
+
+
+ •
+ |
+ |
+
+
+ Standard Python 2.2.1 as implemented on POSIX-compliant
+systems.
+ |
+
NOTES
-
+
+
+
+ |
+
+ DELETING LOCAL FOLDERS |
+
+
- |
-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 people
-might think that it would be wise to just delete all their
-local mail folders periodically. If you do this with
+ | |
+
+ 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
+people 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 status 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 this
-situation) |
-
+from the server as well. (If you don’t understand
+this, don’t worry; you probably won’t encounter
+this situation)
+
+
+
+
+
+ |
+
+ COPYING MESSAGES BETWEEN FOLDERS |
+
+
- |
-COPYING MESSAGES BETWEEN FOLDERS |
-
-
-
- |
-Normally, when you copy a message between folders or add a
-new message to a folder locally, OfflineIMAP will
+ | |
+
+ Normally, when you copy a message between folders or add
+a 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,
@@ -1367,137 +1492,117 @@ upload the message to the IMAP 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 no risk of data
-loss. |
-
+deleting it, so there should be no risk of data loss.
+
+
+
+
+
-
-
-
- |
-There is an OfflineIMAP mailing list available. |
-
-
-
- |
-To subscribe, send the text "Subscribe" in the
+ | |
+
+ 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. |
+post, send the message to offlineimap@complete.org.
+
+
BUGS
-
-
+
- |
-Reports of bugs should be sent via e-mail to the
+ | |
+
+ 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. |
+status or contribute to fixing them.
+
+
COPYRIGHT
-
-
+
- |
-OfflineIMAP is Copyright (C) 2002 John Goerzen. |
-
-
-
- |
-This program is free software; you can redistribute it
+ | |
+
+ OfflineIMAP is Copyright (C) 2002 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 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
+version.
+
+ 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
-details. |
-
-
-
- |
-You should have received a copy of the GNU General Public
-License along with this program; if not, write
-to: |
-
-
-
- |
-Free Software Foundation, Inc.
+details.
+
+You should have received a copy of the GNU General Public
+License along with this program; if not, write to:
+
+Free Software Foundation, Inc.
59 Temple Place
Suite 330
Boston, MA 02111-1307
-USA |
+USA
+
+
AUTHOR
-
-
+
- |
-OfflineIMAP, its libraries, documentation, and all
+ | |
+
+ 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
-its homepage via either Gopher or HTTP: |
-
-
-
- |
-gopher://quux.org/1/devel/offlineimap
-http://quux.org/devel/offlineimap |
-
-
-
- |
-OfflineIMAP may also be downloaded using Subversion.
+as stated in the COPYRIGHT section.
+
+ OfflineIMAP may be downloaded, and information found,
+from its homepage via either Gopher or HTTP:
+
+gopher://quux.org/1/devel/offlineimap
+http://quux.org/devel/offlineimap
+
+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 information on getting OfflineIMAP with Subversion,
-please visit: |
-
-
-
- |
-http://svn.complete.org/ |
+please visit:
+
+http://svn.complete.org/
+
+
SEE ALSO
-
-
+
+ |
+
+ mutt(1), python(1).
+ |
+