Debian Codegraph @

README

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