From 64dc8a1ed4e15ce456a699184a4fff263f2c902f Mon Sep 17 00:00:00 2001
From: Guilhem Moulin <guilhem@fripost.org>
Date: Wed, 9 Sep 2015 00:44:05 +0200
Subject: Add support for the IMAP COMPRESS extension [RFC4978].

Also, add traffic statistics after closing the connection to the IMAP
server.
---
 README | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'README')

diff --git a/README b/README
index 44190f3..0e93fe9 100644
--- a/README
+++ b/README
@@ -71,6 +71,13 @@ type=imaps.
     remote: ~user/.ssh/authorized_keys:
       command="/usr/lib/dovecot/imap",no-agent-forwarding,no-port-forwarding,no-pty,no-user-rc,no-X11-forwarding ssh-... id-interimap
 
+However for long-lived connections (using the --watch command-line
+option), the TLS overhead becomes negligible hence the advantage offered
+by the OpenSSH ControlPersist feature is not obvious.  Furthermore if
+the remote server supports the IMAP COMPRESS extension [RFC4978], adding
+compress=DEFLATE to the configuration can also greatly reduce bandwidth
+usage with regular INET sockets (type=imaps or type=imap).
+
 
 #######################################################################
 
-- 
cgit v1.2.3


From 47fec06f75d365259c6bf1da78dfc4b5548ce5fe Mon Sep 17 00:00:00 2001
From: Guilhem Moulin <guilhem@fripost.org>
Date: Wed, 9 Sep 2015 22:30:00 +0200
Subject: Add a list of supported extensions.

---
 README      | 13 ++++++++-----
 interimap.1 | 29 ++++++++++++++++++++++++-----
 2 files changed, 32 insertions(+), 10 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 0e93fe9..2809ccb 100644
--- a/README
+++ b/README
@@ -23,11 +23,14 @@ the last synchronization only gives a phenomenal performance boost and
 drastically reduces the network traffic.
 
 For convenience reasons servers must also support LIST-EXTENDED
-[RFC5258], LIST-STATUS [RFC5819] and UIDPLUS [RFC4315].  Furthermore,
-while InterIMAP can work with servers lacking support for LITERAL+
-[RFC2088] and MULTIAPPEND [RFC3502], these extensions greatly improve
-performance by reducing the number of required round trips hence are
-recommended.
+[RFC5258], LIST-STATUS [RFC5819] and UIDPLUS [RFC4315].  Other supported
+extensions are:
+  * LITERAL+ [RFC2088] non-synchronizing literals (recommended),
+  * MULTIAPPEND [RFC3502] (recommended),
+  * COMPRESS=DEFLATE [RFC4978] (recommended),
+  * SASL-IR [RFC4959] SASL Initial Client Response,
+  * UNSELECT [RFC3691], and
+  * BINARY [RFC3516].
 
 
 #######################################################################
diff --git a/interimap.1 b/interimap.1
index e552351..988fa16 100644
--- a/interimap.1
+++ b/interimap.1
@@ -15,10 +15,7 @@ servers.
 Such synchronization is made possible by the QRESYNC extension from
 [RFC7162]; for convenience reasons servers must also support
 LIST\-EXTENDED [RFC5258], LIST\-STATUS [RFC5819] and UIDPLUS [RFC4315].
-Furthermore, while \fBInterIMAP\fR can work with servers lacking support
-for LITERAL+ [RFC2088] and MULTIAPPEND [RFC3502], these extensions
-greatly improve performance by reducing the number of required round
-trips hence are recommended.
+See also the \fBSUPPORTED EXTENSIONS\fR section.
 
 .PP
 Stateful synchronization is only possible for mailboxes supporting
@@ -336,6 +333,24 @@ This option is only available in the default section, and is ignored if
 either server does not advertize \(lqBINARY\(rq in its capability list.
 (Default: \(lqYES\(rq.)
 
+.SH SUPPORTED EXTENSIONS
+
+Performance is better for servers supporting the following extensions to
+the IMAP4rev1 [RFC3501] protocol:
+
+.IP \[bu]
+LITERAL+ [RFC2088] non-synchronizing literals (recommended),
+.IP \[bu]
+MULTIAPPEND [RFC3502] (recommended),
+.IP \[bu]
+COMPRESS=DEFLATE [RFC4978] (recommended),
+.IP \[bu]
+SASL-IR [RFC4959] SASL Initial Client Response,
+.IP \[bu]
+UNSELECT [RFC3691], and
+.IP \[bu]
+BINARY [RFC3516].
+
 .SH KNOWN BUGS AND LIMITATIONS
 
 .IP \[bu]
@@ -354,10 +369,14 @@ a message is moved to another mailbox (using the MOVE command from
 [RFC6851] or COPY + STORE + EXPUNGE), moving a messages causes
 \fBInterIMAP\fR to believe that it was deleted while another one (which
 is replicated again) was added to the other mailbox in the meantime.
-
 .IP \[bu]
 \(lqPLAIN\(rq and \(lqLOGIN\(rq are the only authentication mechanisms
 currently supported.
+.IP \[bu]
+\fBInterIMAP\fR will probably not work with non RFC-compliant servers.
+In particular, no work-around are currently implemented beside the
+tunable in the configuration file.  Morever, few IMAP servers have been
+tested so far.
 
 .SH AUTHOR
 Written by Guilhem Moulin
-- 
cgit v1.2.3