README.md

Welcome

This is the Cyrus IMAP Server, version series 3.0.x.

No further development work will progress on anything older than version 2.3.
Versions 2.3 and 2.4 still receive security updates, but new features or
non-security bugfixes are unlikely to be backported. Version 2.5 still
receives security updates and non-security bugfixes. Version 3.0 is under
active development.

What is Cyrus

Cyrus is an IMAP server, where IMAP (Internet Message Access Protocol)
is a protocol for accessing mail.

The Cyrus IMAP server differs from other IMAP server implementations in
that it is generally intended to be run on "sealed" servers, where
normal users are not permitted to log in. The mailbox database is stored
in parts of the filesystem that are private to the Cyrus IMAP system.
All user access to mail is through the IMAP, NNTP, or POP3 protocols.

The private mailbox database design gives the server large advantages in
efficiency, scalability, and administrability. Multiple concurrent
read/write connections to the same mailbox are permitted. The server
supports access control lists on mailboxes and storage quotas on mailbox
hierarchies.

Cyrus goals

To be the best open source secure, scalable mail server, providing
breadth and depth of functionality across email, contacts, calendar
and related messaging services!

How to install Cyrus from git source

The latest development code is on the branch called 'master',
and the latest code destined for the stable release is on
the branch 'cyrus-imapd-$major.$minor'. So the current
stable release is called cyrus-imapd-2.5

Unlike releases, the git repository doesn't have a pre-built
./configure script. You need to generate it with autoreconf:

$ autoreconf -i
$ ./configure
$ make
$ sudo make install

If you need to build a local copy of the docs current to the version of the code, these need to be built: see doc/README.docs

Licensing Information

See the COPYING file in this distribution.

Contact us

Whether you have a success story to share, or a bug to file, or a
request for help or a feature to add or some documentation to contribute
or you'd just like to say hi, we want to hear from you! See
http://www.cyrusimap.org/feedback.html for various ways you can get hold
of us.