Cyrus IMAP
**********

Welcome to Cyrus IMAP and SASL.

======================================================================


What is Cyrus IMAP?
===================

Cyrus IMAP is an email, contacts and calendar server.

This is the documentation for version 3.0.4 (stable) of Cyrus IMAP.

Looking for the latest development version of Cyrus IMAP?
Documentation at https://www.cyrusimap.org/dev/ for 3.1.0.


Features
--------

This is the highlight reel of Cyrus’s full list of features.

* **Security**: Cyrus runs on sealed servers, where normal users
  can’t log in. Users access mail through IMAP/POP or KPOP.

* **Performance and scalability**: The mail spool uses a filesystem
  layout.

* **Filtering**: Server-side mail filtering via Sieve.

* **Efficiency**, ease of administration: The private mailbox
  database design gives Cyrus considerable advantages. 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.

* **Beyond Email**: Support for CalDAV and CardDAV provides an
  integrated calendaring and email solution.

* **Scalability**: Cyrus Murder provides horizontal scalability:
  distributing the load across a pool of servers, without limiting to
  a particular subset of the IMAP namespace.

* **Authentication**: Supports X.509 PKI auth via STARTTLS and
  EXTERNAL. Plus all the Cyrus SASL options.

Cyrus IMAP

* Download

  * Get Cyrus

    * Distribution Package

    * Build and Install Yourself

    * External Tools

    * Licensing

  * Release Notes

    * Stable Version

    * Development Version

    * Supported Product Series

    * Older Versions

  * Notes for Packagers

    * Sample configuration files

    * Predefined configurations

    * Services in "/etc/services"

* Quickstart Guide

  * Introduction to Cyrus IMAP

    * What is IMAP?

  * Coming Soon

  * Quick install

    * 1. Install Cyrus reference packages

    * 2. Use “apt-get install -f” to complete installation

    * 3. Setup the cyrus:mail user and group

    * 4. Setting up authentication with SASL

    * 5. Setup mail delivery from your MTA

    * 6. Protocol ports

    * 7. Configuring Cyrus

    * 8. Launch Cyrus

    * Feature overview

* Overview

  * Features

    * Security and Authentication

    * Mailbox Management

    * Message Management

    * Calendar and Contact (DAV) Collection Management

    * Storage

    * Load Management

  * Concepts

    * Access Control Lists

    * Login Authentication

    * Quotas

    * New Mail Notification

    * Partitions

    * News

    * POP3 Server

    * The syslog facility

    * Mail Directory Recovery

    * Configuration Directory

    * Message Delivery

    * Sieve, a Mail Filtering Language

    * Cyrus Murder, the IMAP Aggregator

* Setup

  * Compiling

    * Setting up dependencies

    * Compile Cyrus

  * Installing Cyrus

    * Install Cyrus

    * Optional Components

    * Setting up syslog

    * Create Cyrus environment

    * Launch Cyrus

    * Send a test email

    * Checking CardDAV and CardDAV

    * Troubleshooting

  * Upgrading to 3.0

    * 1. Preparation

    * 2. Install new 3.0 Cyrus

    * 3. Shut down existing Cyrus

    * 4. Backup and Copy existing data

    * 5. Copy config files and update

    * 6. Upgrade specific items

    * 7. Start new 3.0 Cyrus and verify

    * 8. Reconstruct databases and cache

    * 9. Do you want any new features?

    * 10. Upgrade complete

    * Special note for Murder configurations

  * Configuration Guide

    * Deployment Scenarios

    * Cyrus Murder: Server aggregation

    * Cyrus Replication

    * Hosted Environments

    * Databases

    * Mailbox Creation Distribution

    * Known Protocol Limitations

    * Authentication and Authorization

    * Performance Recommendations

    * Storage Considerations

    * Supported Platforms and System Requirements

* Operations

  * Man pages

    * (5) Configuration Files

    * (8) System Commands

    * (1) User Commands

  * Tools & Utilities

    * arbitron

    * arbitronsort.pl

    * chk_cyrus

    * ctl_cyrusdb

    * ctl_deliver

    * ctl_mboxlist

    * cvt_cyrusdb

    * cvt_cyrusdb_all

    * cyr_dbtool

    * cyr_df

    * cyrdump

    * cyr_expire

    * cyr_virusscan

    * fetchnews

    * cyr_sequence

    * cyr_synclog

    * cyr_userseen

    * masssievec

    * mbexamine

    * mbpath

    * mkimap

    * mknewsgroups

    * rehash

    * translatesieve

    * undohash

  * Administrator Guide

    * Architecture

    * Management

  * Frequently Asked Questions

    * Features

    * Installation Problems

    * Common Feature Requests

    * Common Operational Questions

    * Common Interoperability Problems

* Developers

  * We need your help

  * Contribute docs

    * Overview

    * Documentation Tools

    * Building the files

    * Submitting updates

    * Special Tags

    * Conventions: Man Pages

  * Contribute code and tests

    * Getting Started

    * System files and Databases

    * Resources

    * Releasing

  * Cyrus.Works

* Support/Community

  * Found a bug?

  * Mailing lists

    * Archives

    * Subscribe/Unsubscribe

    * Digest Lists

  * IRC

  * Weekly meetings

  * About

    * What is Cyrus

    * Who Is Cyrus

    * Cyrus Roadmap

    * Cyrus History

    * Cyrus Bylaws

======================================================================


What is Cyrus SASL?
===================

Simple Authentication and Security Layer (SASL) is a specification
that describes how authentication mechanisms can be plugged into an
application protocol on the wire. Cyrus SASL is an implementation of
SASL that makes it easy for application developers to integrate
authentication mechanisms into their application in a generic way.

The latest stable version of Cyrus SASL is 2.1.26.

Read more about *Cyrus SASL*.

Cyrus SASL

* Cyrus SASL

======================================================================


How can we help you?
====================

Administrators, looking to install and maintain Cyrus.

Contributors, looking to add to Cyrus. (We include testers and
documenters too!)
