/offlineimap/head: changeset 510
Final commits before 4.0. This is the re-built manual and updated ChangeLog.
This commit is contained in:
jgoerzen
parent
ded1261411
commit
b8a3bcb0a1
@ -1,3 +1,141 @@
|
|||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 509: jgoerzen | 2003-07-18 13:49:13 -0500 (Fri, 18 Jul 2003) | 3 lines
|
||||||
|
Changed paths:
|
||||||
|
A /offlineimap/head/UPGRADING
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/offlineimap.1
|
||||||
|
M /offlineimap/head/offlineimap.sgml
|
||||||
|
|
||||||
|
Added a section on upgrading to the documentation
|
||||||
|
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 487: jgoerzen | 2003-06-26 14:03:07 -0500 (Thu, 26 Jun 2003) | 2 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/bin/offlineimap
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/offlineimap/folder/Maildir.py
|
||||||
|
M /offlineimap/head/offlineimap/version.py
|
||||||
|
M /offlineimap/head/offlineimap.py
|
||||||
|
|
||||||
|
Fixed version confusion
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 486: jgoerzen | 2003-06-26 13:38:47 -0500 (Thu, 26 Jun 2003) | 2 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/bin/offlineimap
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/offlineimap/version.py
|
||||||
|
M /offlineimap/head/offlineimap.py
|
||||||
|
|
||||||
|
Prep for 3.99.19
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 485: jgoerzen | 2003-06-26 13:28:54 -0500 (Thu, 26 Jun 2003) | 5 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/offlineimap/folder/IMAP.py
|
||||||
|
|
||||||
|
* Applied patch from Joerg Wendland <joergland@debian.org> to use
|
||||||
|
APPENDUID result from mail servers that provide it. Closes: #198772.
|
||||||
|
|
||||||
|
Resolves: [debian.org #198772]
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 484: jgoerzen | 2003-06-02 11:17:29 -0500 (Mon, 02 Jun 2003) | 7 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/offlineimap/folder/IMAP.py
|
||||||
|
M /offlineimap/head/offlineimap/imapserver.py
|
||||||
|
|
||||||
|
* Added a "force" option to imapserver/select to force a reloading of a
|
||||||
|
folder. Per [complete.org #67], when cachemessagelist() was called
|
||||||
|
on an object that was cached from a previous run, it would not
|
||||||
|
re-issue the select().
|
||||||
|
|
||||||
|
Closes: [complete.org #67]
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 482: jgoerzen | 2003-06-02 11:11:51 -0500 (Mon, 02 Jun 2003) | 1 line
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/debian/control
|
||||||
|
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 481: jgoerzen | 2003-06-02 11:09:57 -0500 (Mon, 02 Jun 2003) | 2 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/Makefile
|
||||||
|
M /offlineimap/head/bin/offlineimap
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/debian/rules
|
||||||
|
M /offlineimap/head/offlineimap.py
|
||||||
|
M /offlineimap/head/setup.py
|
||||||
|
|
||||||
|
Updated
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 480: jgoerzen | 2003-06-02 09:52:33 -0500 (Mon, 02 Jun 2003) | 3 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/offlineimap/init.py
|
||||||
|
M /offlineimap/head/offlineimap/ui/UIBase.py
|
||||||
|
|
||||||
|
Fixed the -l option
|
||||||
|
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 479: jgoerzen | 2003-06-02 09:07:30 -0500 (Mon, 02 Jun 2003) | 2 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/offlineimap/init.py
|
||||||
|
|
||||||
|
Made -d recognized
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 478: jgoerzen | 2003-06-02 09:06:18 -0500 (Mon, 02 Jun 2003) | 4 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/Makefile
|
||||||
|
M /offlineimap/head/bin/offlineimap
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/debian/control
|
||||||
|
M /offlineimap/head/debian/rules
|
||||||
|
M /offlineimap/head/manual.html
|
||||||
|
M /offlineimap/head/manual.pdf
|
||||||
|
M /offlineimap/head/manual.ps
|
||||||
|
M /offlineimap/head/manual.txt
|
||||||
|
M /offlineimap/head/offlineimap/imaplib.py
|
||||||
|
M /offlineimap/head/offlineimap/imapserver.py
|
||||||
|
M /offlineimap/head/offlineimap/init.py
|
||||||
|
M /offlineimap/head/offlineimap/ui/Curses.py
|
||||||
|
M /offlineimap/head/offlineimap/ui/TTY.py
|
||||||
|
M /offlineimap/head/offlineimap/ui/Tk.py
|
||||||
|
M /offlineimap/head/offlineimap/ui/UIBase.py
|
||||||
|
M /offlineimap/head/offlineimap.1
|
||||||
|
M /offlineimap/head/offlineimap.py
|
||||||
|
M /offlineimap/head/offlineimap.sgml
|
||||||
|
M /offlineimap/head/setup.py
|
||||||
|
|
||||||
|
Added -l option. Updated documentation for it. Changed _msg to _display
|
||||||
|
override in UI modules. Renamed "doc" to "docs" target in Makefile to avoid
|
||||||
|
conflicting with a subdir.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 477: jgoerzen | 2003-05-27 17:01:27 -0500 (Tue, 27 May 2003) | 2 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/debian/changelog
|
||||||
|
M /offlineimap/head/offlineimap/folder/IMAP.py
|
||||||
|
M /offlineimap/head/offlineimap/imaplib.py
|
||||||
|
|
||||||
|
Fixed SSL for Python2.3.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
rev 475: jgoerzen | 2003-05-06 09:27:36 -0500 (Tue, 06 May 2003) | 2 lines
|
||||||
|
Changed paths:
|
||||||
|
M /offlineimap/head/ChangeLog
|
||||||
|
M /offlineimap/head/bin/offlineimap
|
||||||
|
M /offlineimap/head/offlineimap/version.py
|
||||||
|
M /offlineimap/head/offlineimap.py
|
||||||
|
|
||||||
|
Preparing for 3.99.17
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
------------------------------------------------------------------------
|
||||||
rev 474: jgoerzen | 2003-05-06 09:26:12 -0500 (Tue, 06 May 2003) | 17 lines
|
rev 474: jgoerzen | 2003-05-06 09:26:12 -0500 (Tue, 06 May 2003) | 17 lines
|
||||||
Changed paths:
|
Changed paths:
|
||||||
|
|||||||
@ -229,7 +229,9 @@ CLASS="APPLICATION"
|
|||||||
>OfflineIMAP</SPAN
|
>OfflineIMAP</SPAN
|
||||||
> supports many
|
> supports many
|
||||||
features (offline reading, for one) that most IMAP-aware
|
features (offline reading, for one) that most IMAP-aware
|
||||||
readers don't.
|
readers don't. However, this feature is not as time-tested
|
||||||
|
as traditional syncing, so my advice is to stick with normal
|
||||||
|
methods of operation for the time being.
|
||||||
</P
|
</P
|
||||||
></DIV
|
></DIV
|
||||||
></DIV
|
></DIV
|
||||||
@ -1483,6 +1485,19 @@ CLASS="APPLICATION"
|
|||||||
</P
|
</P
|
||||||
></DD
|
></DD
|
||||||
><DT
|
><DT
|
||||||
|
>I've upgraded and now <SPAN
|
||||||
|
CLASS="APPLICATION"
|
||||||
|
>OfflineIMAP</SPAN
|
||||||
|
>
|
||||||
|
crashes when I start it up! Why?</DT
|
||||||
|
><DD
|
||||||
|
><P
|
||||||
|
>You need to upgrade your configuration
|
||||||
|
file. See at the end of this
|
||||||
|
manual.
|
||||||
|
</P
|
||||||
|
></DD
|
||||||
|
><DT
|
||||||
>How do I specify the names of my folders?</DT
|
>How do I specify the names of my folders?</DT
|
||||||
><DD
|
><DD
|
||||||
><P
|
><P
|
||||||
@ -1712,7 +1727,7 @@ CLASS="PROPERTY"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
||||||
><A
|
><A
|
||||||
NAME="AEN478"
|
NAME="AEN484"
|
||||||
></A
|
></A
|
||||||
><H2
|
><H2
|
||||||
>Conforming To</H2
|
>Conforming To</H2
|
||||||
@ -1722,7 +1737,7 @@ NAME="AEN478"
|
|||||||
><LI
|
><LI
|
||||||
><P
|
><P
|
||||||
>Internet Message Access Protocol version 4rev1 (IMAP 4rev1) as
|
>Internet Message Access Protocol version 4rev1 (IMAP 4rev1) as
|
||||||
specified in RFC2060</P
|
specified in RFC2060 and RFC3501</P
|
||||||
></LI
|
></LI
|
||||||
><LI
|
><LI
|
||||||
><P
|
><P
|
||||||
@ -1751,14 +1766,14 @@ TARGET="_top"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
||||||
><A
|
><A
|
||||||
NAME="AEN491"
|
NAME="AEN497"
|
||||||
></A
|
></A
|
||||||
><H2
|
><H2
|
||||||
>Notes</H2
|
>Notes</H2
|
||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN493"
|
NAME="AEN499"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Deleting Local Folders</H3
|
>Deleting Local Folders</H3
|
||||||
@ -1790,7 +1805,7 @@ CLASS="APPLICATION"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN500"
|
NAME="AEN506"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Multiple Instances</H3
|
>Multiple Instances</H3
|
||||||
@ -1819,7 +1834,7 @@ CLASS="PROPERTY"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN507"
|
NAME="AEN513"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Copying Messages Between Folders</H3
|
>Copying Messages Between Folders</H3
|
||||||
@ -1849,7 +1864,7 @@ CLASS="APPLICATION"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN513"
|
NAME="AEN519"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Use with Evolution</H3
|
>Use with Evolution</H3
|
||||||
@ -1885,7 +1900,7 @@ CLASS="APPLICATION"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN521"
|
NAME="AEN527"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Use with KMail</H3
|
>Use with KMail</H3
|
||||||
@ -1919,7 +1934,7 @@ CLASS="APPLICATION"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN529"
|
NAME="AEN535"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Mailing List</H3
|
>Mailing List</H3
|
||||||
@ -1938,7 +1953,7 @@ TARGET="_top"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT2"
|
CLASS="REFSECT2"
|
||||||
><A
|
><A
|
||||||
NAME="AEN533"
|
NAME="AEN539"
|
||||||
></A
|
></A
|
||||||
><H3
|
><H3
|
||||||
>Bugs</H3
|
>Bugs</H3
|
||||||
@ -1964,7 +1979,70 @@ TARGET="_top"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
||||||
><A
|
><A
|
||||||
NAME="AEN539"
|
NAME="UPGRADING.4.0"
|
||||||
|
></A
|
||||||
|
><H2
|
||||||
|
>Upgrading to 4.0</H2
|
||||||
|
><P
|
||||||
|
> If you are upgrading from a version of <SPAN
|
||||||
|
CLASS="APPLICATION"
|
||||||
|
>OfflineIMAP</SPAN
|
||||||
|
> prior to
|
||||||
|
3.99.12, you will find that you will get errors when
|
||||||
|
<SPAN
|
||||||
|
CLASS="APPLICATION"
|
||||||
|
>OfflineIMAP</SPAN
|
||||||
|
> starts up (relating to ConfigParser or
|
||||||
|
AccountHashGenerator) and the
|
||||||
|
configuration file. This is because the config file format
|
||||||
|
had to change to accomodate new features in 4.0. Fortunately,
|
||||||
|
it's not difficult to adjust it to suit.
|
||||||
|
</P
|
||||||
|
><P
|
||||||
|
> First thing you need to do is stop any running <SPAN
|
||||||
|
CLASS="APPLICATION"
|
||||||
|
>OfflineIMAP</SPAN
|
||||||
|
>
|
||||||
|
instance, making sure first that it's synced all your mail.
|
||||||
|
Then, modify your
|
||||||
|
<TT
|
||||||
|
CLASS="FILENAME"
|
||||||
|
>~/.offlineimaprc</TT
|
||||||
|
> file. You'll need to
|
||||||
|
split up each account section (make sure that it now starts
|
||||||
|
with "Account ") into two Repository sections (one for the
|
||||||
|
local side and another for the remote side.) See the files
|
||||||
|
<TT
|
||||||
|
CLASS="FILENAME"
|
||||||
|
>offlineimap.conf.minimal</TT
|
||||||
|
> and
|
||||||
|
<TT
|
||||||
|
CLASS="FILENAME"
|
||||||
|
>offlineimap.conf</TT
|
||||||
|
> in the distribution if
|
||||||
|
you need more assistance.
|
||||||
|
</P
|
||||||
|
><P
|
||||||
|
> <SPAN
|
||||||
|
CLASS="APPLICATION"
|
||||||
|
>OfflineIMAP</SPAN
|
||||||
|
>'s status directory area has also changed.
|
||||||
|
Therefore, you should delete everything in ~/.offlineimap as
|
||||||
|
well as your local mail folders.
|
||||||
|
</P
|
||||||
|
><P
|
||||||
|
> When you start up <SPAN
|
||||||
|
CLASS="APPLICATION"
|
||||||
|
>OfflineIMAP</SPAN
|
||||||
|
> 4.0, it will re-download all
|
||||||
|
your mail from the server and then you can continue using it
|
||||||
|
like normal.
|
||||||
|
</P
|
||||||
|
></DIV
|
||||||
|
><DIV
|
||||||
|
CLASS="REFSECT1"
|
||||||
|
><A
|
||||||
|
NAME="AEN559"
|
||||||
></A
|
></A
|
||||||
><H2
|
><H2
|
||||||
>Copyright</H2
|
>Copyright</H2
|
||||||
@ -2002,7 +2080,7 @@ CLASS="APPLICATION"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
||||||
><A
|
><A
|
||||||
NAME="AEN548"
|
NAME="AEN568"
|
||||||
></A
|
></A
|
||||||
><H2
|
><H2
|
||||||
>Author</H2
|
>Author</H2
|
||||||
@ -2054,7 +2132,7 @@ TARGET="_top"
|
|||||||
><DIV
|
><DIV
|
||||||
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
||||||
><A
|
><A
|
||||||
NAME="AEN560"
|
NAME="AEN580"
|
||||||
></A
|
></A
|
||||||
><H2
|
><H2
|
||||||
>See Also</H2
|
>See Also</H2
|
||||||
|
|||||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
@ -64,7 +64,9 @@ DESCRIPTION
|
|||||||
and point both OfflineIMAP and their mail reader of choice at it. This
|
and point both OfflineIMAP and their mail reader of choice at it. This
|
||||||
is often preferable to the mail reader's own IMAP support since
|
is often preferable to the mail reader's own IMAP support since
|
||||||
OfflineIMAP supports many features (offline reading, for one) that most
|
OfflineIMAP supports many features (offline reading, for one) that most
|
||||||
IMAP-aware readers don't.
|
IMAP-aware readers don't. However, this feature is not as time-tested
|
||||||
|
as traditional syncing, so my advice is to stick with normal methods of
|
||||||
|
operation for the time being.
|
||||||
|
|
||||||
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
|
||||||
@ -546,10 +548,14 @@ OTHER FREQUENTLY ASKED QUESTIONS
|
|||||||
without this extra crutch. You'll get the best results if you
|
without this extra crutch. You'll get the best results if you
|
||||||
don't use this setting, in fact.
|
don't use this setting, in fact.
|
||||||
|
|
||||||
|
I've upgraded and now OfflineIMAP crashes when I start it up! Why?
|
||||||
|
You need to upgrade your configuration file. See [XRef to
|
||||||
|
UPGRADING.4.0] at the end of this manual.
|
||||||
|
|
||||||
How do I specify the names of my folders?
|
How do I specify the names of my folders?
|
||||||
You do not need to. OfflineIMAP is smart enough to automati-
|
You do not need to. OfflineIMAP is smart enough to automati-
|
||||||
cally figure out what folders are present on the IMAP server and
|
cally figure out what folders are present on the IMAP server and
|
||||||
synchronize them. You can use the folderfilter and foldertrans
|
synchronize them. You can use the folderfilter and foldertrans
|
||||||
configuration file options to request certain folders and rename
|
configuration file options to request certain folders and rename
|
||||||
them as they come in if you like.
|
them as they come in if you like.
|
||||||
|
|
||||||
@ -557,68 +563,68 @@ OTHER FREQUENTLY ASKED QUESTIONS
|
|||||||
Use the folderfilter option in the configuration file.
|
Use the folderfilter option in the configuration file.
|
||||||
|
|
||||||
How can I add or delete a folder?
|
How can I add or delete a folder?
|
||||||
OfflineIMAP does not currently provide this feature, but if you
|
OfflineIMAP does not currently provide this feature, but if you
|
||||||
create a new folder on the IMAP server, it will be created
|
create a new folder on the IMAP server, it will be created
|
||||||
locally automatically.
|
locally automatically.
|
||||||
|
|
||||||
Are there any other warnings that I should be aware of?
|
Are there any other warnings that I should be aware of?
|
||||||
Yes; see the Notes section below.
|
Yes; see the Notes section below.
|
||||||
|
|
||||||
What is the mailbox name recorder (mbnames) for?
|
What is the mailbox name recorder (mbnames) for?
|
||||||
Some mail readers, such as Mutt, are not capable of automati-
|
Some mail readers, such as Mutt, are not capable of automati-
|
||||||
cally determining the names of your mailboxes. OfflineIMAP can
|
cally determining the names of your mailboxes. OfflineIMAP can
|
||||||
help these programs by writing the names of the folders ni a
|
help these programs by writing the names of the folders ni a
|
||||||
format you specify. See the example offlineimap.conf for
|
format you specify. See the example offlineimap.conf for
|
||||||
details.
|
details.
|
||||||
|
|
||||||
Can I synchronize multiple accounts with OfflineIMAP?
|
Can I synchronize multiple accounts with OfflineIMAP?
|
||||||
Sure. Just name them all in the accounts line in the general
|
Sure. Just name them all in the accounts line in the general
|
||||||
section of the configuration file, and add a per-account section
|
section of the configuration file, and add a per-account section
|
||||||
for each one.
|
for each one.
|
||||||
|
|
||||||
Does OfflineIMAP support POP?
|
Does OfflineIMAP support POP?
|
||||||
No. POP is not robust enough to do a completely reliable multi-
|
No. POP is not robust enough to do a completely reliable multi-
|
||||||
machine synchronization like OfflineIMAP can do. OfflineIMAP
|
machine synchronization like OfflineIMAP can do. OfflineIMAP
|
||||||
will not support it.
|
will not support it.
|
||||||
|
|
||||||
Does OfflineIMAP support mailbox formats other than Maildir?
|
Does OfflineIMAP support mailbox formats other than Maildir?
|
||||||
Not at present. There is no technical reason not to; just no
|
Not at present. There is no technical reason not to; just no
|
||||||
demand yet. Maildir is a superior format anyway. However,
|
demand yet. Maildir is a superior format anyway. However,
|
||||||
OfflineIMAP can sync between two IMAP servers, and some IMAP
|
OfflineIMAP can sync between two IMAP servers, and some IMAP
|
||||||
servers support other formats. You could install an IMAP server
|
servers support other formats. You could install an IMAP server
|
||||||
on your local machine and have OfflineIMAP sync to that.
|
on your local machine and have OfflineIMAP sync to that.
|
||||||
|
|
||||||
[technical] Why are your Maildir message filenames so huge?
|
[technical] Why are your Maildir message filenames so huge?
|
||||||
OfflineIMAP has two relevant principles: 1) never modifying your
|
OfflineIMAP has two relevant principles: 1) never modifying your
|
||||||
messages in any way and 2) ensuring 100% reliable synchroniza-
|
messages in any way and 2) ensuring 100% reliable synchroniza-
|
||||||
tions. In order to do a reliable sync, OfflineIMAP must have a
|
tions. In order to do a reliable sync, OfflineIMAP must have a
|
||||||
way to uniquely identify each e-mail. Three pieces of informa-
|
way to uniquely identify each e-mail. Three pieces of informa-
|
||||||
tion are required to do this: your account name, the folder
|
tion are required to do this: your account name, the folder
|
||||||
name, and the message UID. The account name can be calculated
|
name, and the message UID. The account name can be calculated
|
||||||
from the path in which your messages are. The folder name can
|
from the path in which your messages are. The folder name can
|
||||||
usually be as well, BUT some mail clients move messages between
|
usually be as well, BUT some mail clients move messages between
|
||||||
folders by simply moving the file, leaving the name intact.
|
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:
|
||||||
@ -637,11 +643,11 @@ OTHER FREQUENTLY ASKED QUESTIONS
|
|||||||
|
|
||||||
CONFORMING TO
|
CONFORMING TO
|
||||||
o Internet Message Access Protocol version 4rev1 (IMAP 4rev1) as speci-
|
o Internet Message Access Protocol version 4rev1 (IMAP 4rev1) as speci-
|
||||||
fied in RFC2060
|
fied in RFC2060 and RFC3501
|
||||||
|
|
||||||
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>.
|
||||||
|
|
||||||
@ -649,105 +655,128 @@ 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 propogated 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
|
||||||
|
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
|
||||||
|
(relating to ConfigParser or AccountHashGenerator) and the configura-
|
||||||
|
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
|
||||||
|
adjust it to suit.
|
||||||
|
|
||||||
|
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
|
||||||
|
~/.offlineimaprc file. You'll need to split up each account section
|
||||||
|
(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
|
||||||
|
the files offlineimap.conf.minimal and offlineimap.conf in the distri-
|
||||||
|
bution if you need more assistance.
|
||||||
|
|
||||||
|
OfflineIMAP's status directory area has also changed. Therefore, you
|
||||||
|
should delete everything in ~/.offlineimap as well as your local mail
|
||||||
|
folders.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
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
|
WITHOUT ANY WARRANTY; without even the implied warranty of MER-
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Gen-
|
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
||||||
eral 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
|
||||||
@ -755,4 +784,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
John Goerzen 02 June 2003 OFFLINEIMAP(1)
|
John Goerzen 18 July 2003 OFFLINEIMAP(1)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user