diff options
| author | Guilhem Moulin <guilhem@fripost.org> | 2020-07-02 00:15:41 +0200 |
|---|---|---|
| committer | Guilhem Moulin <guilhem@fripost.org> | 2020-07-02 00:15:41 +0200 |
| commit | 9bf5257bb6f0e67d49015941827496586271bede (patch) | |
| tree | edc8fe5f36b22b509092395a32e72796efeda85d /doc | |
| parent | c54903cd6308cf4a56a439ea74d3f8943e5b605c (diff) | |
| parent | 95df46e54ce090506cdce1c54616ea849670c2db (diff) | |
Merge tag 'upstream/0.5.1' into debian
Upstream version 0.5.1
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development.md | 2 | ||||
| -rw-r--r-- | doc/getting-started.md | 3 | ||||
| -rw-r--r-- | doc/index.md | 16 |
3 files changed, 18 insertions, 3 deletions
diff --git a/doc/development.md b/doc/development.md index 52ebf90..708712f 100644 --- a/doc/development.md +++ b/doc/development.md @@ -193,7 +193,7 @@ recursively remove the directory `$BASEDIR`. [IMAP4rev1]: https://tools.ietf.org/html/rfc3501 [Dovecot]: https://dovecot.org -[Dovecot Logging]: https://doc.dovecot.org/admin_manual/dovecot_logging/ +[Dovecot Logging]: https://doc.dovecot.org/admin_manual/logging/ [Dovecot LDA]: https://wiki.dovecot.org/LDA [`getlogin`(3)]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/getlogin.html [User Databases]: https://doc.dovecot.org/configuration_manual/authentication/user_databases_userdb/ diff --git a/doc/getting-started.md b/doc/getting-started.md index c497ec6..1d059b4 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -30,7 +30,8 @@ perform significant optimizations, yielding [much faster](benchmark.html) synchronization. *Note*: InterIMAP uses the [Quick Mailbox Resynchronization][RFC 7162] extension for stateful synchronization, hence won't work on IMAP servers -that don't advertise support for that extension. +that don't advertise [support](https://www.imapwiki.org/Specs#line-68) +for that extension. Installing an [IMAP4rev1] server on a single-user workstation may sound overkill, but we argue that most systems, not only servers, come with a diff --git a/doc/index.md b/doc/index.md index d475592..4dd72f1 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,18 +1,32 @@ % InterIMAP & PullIMAP % [Guilhem Moulin](mailto:guilhem@fripost.org) +InterIMAP synchronizes emails and their metadata between a remote IMAP +server and local storage. By leveraging the [*Quick Mailbox +Resynchronization*][RFC 7162] IMAP extension, it can offer [*much better +performance*](benchmark.html) than tools such as [OfflineIMAP]. + +PullIMAP retrieves messages from an IMAP mailbox and deliver them +locally. It can use the the [*IDLE*][RFC 2177] IMAP extension to reduce +both latency and network traffic. + +[RFC 2177]: https://tools.ietf.org/html/rfc2177 +[RFC 7162]: https://tools.ietf.org/html/rfc7162 +[OfflineIMAP]: https://www.offlineimap.org/ + General documentation --------------------- * [Getting started with InterIMAP](getting-started.html) * [Multi-remote setup for InterIMAP](multi-account.html) * [InterIMAP benchmark metrics and comparison](benchmark.html) + * [Presentation at DebConf19](https://debconf19.debconf.org/talks/78-interimap-the-case-for-local-imap-servers-and-fast-bidirectional-synchronization/) Manuals (HTML versions) ----------------------- * [`interimap`(1)](interimap.1.html) — Fast bidirectional - synchronization for QRESYNC-capable IMAP servers + synchronization for IMAP servers * [`pullimap`(1)](pullimap.1.html) — Pull mails from an IMAP mailbox and deliver them to an SMTP session |