README 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. _
  2. (_)___ _ _ _ __ ___
  3. | / __| | | | '_ \ / __|
  4. | \__ \ |_| | | | | (__
  5. |_|___/\__, |_| |_|\___|
  6. |___/
  7. isync/mbsync - free (GPL) mailbox synchronization program
  8. http://isync.sf.net/
  9. See AUTHORS for contact information.
  10. ``mbsync'' is a command line application which synchronizes mailboxes;
  11. currently Maildir and IMAP4 mailboxes are supported. New messages, message
  12. deletions and flag changes can be propagated both ways.
  13. ``mbsync'' is suitable for use in IMAP-disconnected mode.
  14. Synchronization is based on unique message identifiers (UIDs), so
  15. no identification conflicts can occur (unlike with some other mail
  16. synchronizers).
  17. Synchronization state is kept in one local text file per mailbox pair;
  18. these files are protected against concurrent ``mbsync'' processes.
  19. Mailboxes can be safely modified while ``mbsync'' operates.
  20. Multiple replicas of each mailbox can be maintained.
  21. isync is the project name, while mbsync is the current executable name; this
  22. change was necessary because of massive changes in the user interface. An
  23. isync executable still exists; it is a compatibility wrapper around mbsync.
  24. * Features
  25. * Fine-grained selection of synchronization operations to perform
  26. * Synchronizes single mailboxes or entire mailbox collections
  27. * Partial mirrors possible: keep only the latest messages locally
  28. * Trash functionality: backup messages before removing them
  29. * IMAP features:
  30. * Supports TLS/SSL via imaps: (port 993) and STARTTLS
  31. * Supports SASL for authentication
  32. * Pipelining for maximum speed
  33. * Compatibility
  34. isync should work fairly well with any IMAP4 compliant server;
  35. servers that support the UIDPLUS and LITERAL+ extensions are most
  36. efficient.
  37. Courier 1.4.3 is known to be buggy, version 1.7.3 works fine.
  38. M$ Exchange (2013 at least) needs DisableExtension MOVE to be compatible
  39. with the Trash functionality.
  40. * Platforms
  41. At some point, ``isync'' has successfully run on:
  42. Linux, Solaris 2.7, OpenBSD 2.8, FreeBSD 4.3.
  43. * Requirements
  44. perl v5.14+
  45. Berkeley DB 4.1+ (optional)
  46. OpenSSL for TLS/SSL support (optional)
  47. Cyrus SASL (optional)
  48. zlib (optional)
  49. The build from git also requires:
  50. GNU autotools (autoconf & automake)
  51. perl module Date::Parse (libtimedate-perl on Debian, perl-TimeDate on
  52. Fedora and Suse)
  53. * Installation
  54. ./autogen.sh (only when building from git)
  55. ./configure
  56. make
  57. sudo make install
  58. * Help
  59. Please see the man page for complete documentation.