README 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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.
  23. * Features
  24. * Fine-grained selection of synchronization operations to perform
  25. * Synchronizes single mailboxes or entire mailbox collections
  26. * Partial mirrors possible: keep only the latest messages locally
  27. * Trash functionality: backup messages before removing them
  28. * IMAP features:
  29. * Supports TLS/SSL via imaps: (port 993) and STARTTLS
  30. * Supports SASL for authentication
  31. * Pipelining for maximum speed
  32. * Compatibility
  33. isync should work fairly well with any IMAP4 compliant server;
  34. servers that support the UIDPLUS and LITERAL+ extensions are most
  35. efficient.
  36. Courier 1.4.3 is known to be buggy, version 1.7.3 works fine.
  37. M$ Exchange (2013 at least) needs DisableExtension MOVE to be compatible
  38. with the Trash functionality.
  39. * Platforms
  40. At some point, ``isync'' has successfully run on:
  41. Linux, Solaris 2.7, OpenBSD 2.8, FreeBSD 4.3.
  42. * Requirements
  43. perl v5.14+
  44. Berkeley DB 4.1+ (optional)
  45. OpenSSL for TLS/SSL support (optional)
  46. Cyrus SASL (optional)
  47. zlib (optional)
  48. The build from git also requires:
  49. GNU autotools (autoconf & automake)
  50. perl module Date::Parse (libtimedate-perl on Debian, perl-TimeDate on
  51. Fedora and Suse)
  52. * Installation
  53. ./autogen.sh (only when building from git)
  54. ./configure
  55. make
  56. sudo make install
  57. * Help
  58. Please see the man page for complete documentation.