• Home
  • Download
  • Contribute
  • Support
  • Cyrus SASL
CYRUS

Cyrus IMAP

  • 1. Download
    • 1.1. Get Cyrus
      • 1.1.1. Distribution Package
        • 1.1.1.1. CentOS
        • 1.1.1.2. Debian
        • 1.1.1.3. Fedora
        • 1.1.1.4. openSUSE
        • 1.1.1.5. Red Hat Enterprise Linux
        • 1.1.1.6. Ubuntu
      • 1.1.2. Build and Install Yourself
        • 1.1.2.1. Use a release packaged tarball
        • 1.1.2.2. Use the source from Git
      • 1.1.3. External Tools
      • 1.1.4. Licensing
    • 1.2. Release Notes
      • 1.2.1. Stable Version
      • 1.2.2. Development Version
      • 1.2.3. Supported Product Series
        • 1.2.3.2. Series 3.0
        • 1.2.3.3. Series 2.5
        • 1.2.3.4. Series 2.4
      • 1.2.4. Older Versions
        • 1.2.4.1. Series 1
        • 1.2.4.2. Series 2: 2.0 - 2.3
    • 1.3. Notes for Packagers
      • 1.3.1. Binary naming
      • 1.3.2. Sample configuration files
      • 1.3.3. Predefined configurations
        • 1.3.3.1. The configuration file for master: cyrus.conf
        • 1.3.3.2. The configuration file for the various programs: imapd.conf
      • 1.3.4. Services in /etc/services
  • 2. Quickstart Guide
    • 2.1. Introduction to Cyrus IMAP
      • 2.1.1. What is IMAP?
    • 2.2. Quick install
      • 2.2.1. 1. Install Cyrus reference packages
      • 2.2.2. 2. Use “apt-get install -f” to complete installation
      • 2.2.3. 3. Setup the cyrus:mail user and group
      • 2.2.4. 4. Setting up authentication with SASL
      • 2.2.5. 5. Setup mail delivery from your MTA
        • 2.2.5.1. Install Sendmail
        • 2.2.5.2. Sendmail communication
        • 2.2.5.3. Install Postfix
      • 2.2.6. 6. Protocol ports
      • 2.2.7. 7. Configuring Cyrus
      • 2.2.8. 8. Launch Cyrus
      • 2.2.9. Feature overview
  • 3. Overview
    • 3.1. Features
      • 3.1.1. Security and Authentication
        • 3.1.1.1. Kerberos Authentication
        • 3.1.1.2. LDAP Authentication
        • 3.1.1.3. SQL Authentication
        • 3.1.1.4. Access Control
        • 3.1.1.5. Sealed System Design
      • 3.1.2. Mailbox Management
        • 3.1.2.1. Automatic Creation of Mailboxes
        • 3.1.2.2. Mailbox Namespaces
        • 3.1.2.3. Virtual Domains
        • 3.1.2.4. Mailbox Annotations (METADATA)
        • 3.1.2.5. Mailbox Distribution
      • 3.1.3. Message Management
        • 3.1.3.1. Delayed Delete
        • 3.1.3.2. Delayed Expunge
        • 3.1.3.3. Message Annotations (METADATA)
        • 3.1.3.4. Duplicate Message Delivery Suppression
        • 3.1.3.5. Shared Seen State
        • 3.1.3.6. Server Side Filtering (Sieve)
        • 3.1.3.7. Event Notifications
      • 3.1.4. Calendar and Contact (DAV) Collection Management
        • 3.1.4.1. CalDAV Collections
        • 3.1.4.2. DAV Components
        • 3.1.4.3. DAV Collection Management
        • 3.1.4.4. CardDAV Support
      • 3.1.5. Storage
        • 3.1.5.1. Mail Spool Partitions
        • 3.1.5.2. Mailbox Metadata Partitions
        • 3.1.5.3. Archiving
        • 3.1.5.4. Quota
        • 3.1.5.5. Single-Instance Store
      • 3.1.6. Load Management
        • 3.1.6.1. Cyrus IMAP Murder (Server Aggregation)
    • 3.2. Concepts
      • 3.2.1. Access Control Lists
        • 3.2.1.1. Working with ACLs
        • 3.2.1.2. Sample ACL
        • 3.2.1.3. Access Rights
        • 3.2.1.4. Access Control Defaults
        • 3.2.1.5. Access Control Identifier (ACI)
        • 3.2.1.6. Negative Rights
        • 3.2.1.7. Calculating a Users’ Rights
      • 3.2.2. Login Authentication
        • 3.2.2.1. Anonymous Login
        • 3.2.2.2. Plaintext Authentication
        • 3.2.2.3. Kerberos Logins
        • 3.2.2.4. Shared Secrets Logins
      • 3.2.3. Quotas
        • 3.2.3.1. Working with Quotas
        • 3.2.3.2. Monitor and Repair
        • 3.2.3.3. Supported Quota Types
        • 3.2.3.4. Quota Roots
        • 3.2.3.5. Controlling Quota Behavior
        • 3.2.3.6. Mail Delivery Behavior
        • 3.2.3.7. Quota Warnings Upon Select When User Has d Rights
        • 3.2.3.8. Quotas and Partitions
      • 3.2.4. New Mail Notification
      • 3.2.5. Partitions
        • 3.2.5.1. Specifying Partitions with “create”
        • 3.2.5.2. Changing Partitions with “rename”
      • 3.2.6. News
      • 3.2.7. POP3 Server
      • 3.2.8. The syslog facility
      • 3.2.9. Mail Directory Recovery
        • 3.2.9.1. Reconstructing Mailbox Directories
        • 3.2.9.2. Reconstructing the Mailboxes File
        • 3.2.9.3. Reconstructing Quota Roots
        • 3.2.9.4. Removing Quota Roots
        • 3.2.9.5. Subscriptions
      • 3.2.10. Configuration Directory
        • 3.2.10.1. Log Directory
        • 3.2.10.2. Proc Directory
      • 3.2.11. Message Delivery
        • 3.2.11.1. Local Mail Transfer Protocol (lmtp)
        • 3.2.11.2. Single Instance Store
        • 3.2.11.3. Duplicate Delivery Suppression
      • 3.2.12. Sieve, a Mail Filtering Language
      • 3.2.13. Cyrus Murder, the IMAP Aggregator
  • 4. Setup
    • 4.1. Compiling
      • 4.1.1. Setting up dependencies
        • 4.1.1.1. Required Build Dependencies
        • 4.1.1.2. Optional Build Dependencies
      • 4.1.2. Compile Cyrus
        • 4.1.2.1. Default build: mail only
        • 4.1.2.2. Optional dependencies
        • 4.1.2.3. Compile
        • 4.1.2.4. Check
    • 4.2. Installing Cyrus
      • 4.2.1. Install Cyrus
      • 4.2.2. Optional Components
        • 4.2.2.1. HTTP modules
        • 4.2.2.2. Virus Scanner
      • 4.2.3. Setting up syslog
      • 4.2.4. Create Cyrus environment
        • 4.2.4.1. Set up the cyrus:mail user and group
        • 4.2.4.2. Authentication with SASL
        • 4.2.4.3. Mail delivery from your MTA
        • 4.2.4.4. Protocol ports
        • 4.2.4.5. Cyrus config files
        • 4.2.4.6. Optional: Setting up SSL certificates
        • 4.2.4.7. Prepare ephemeral (run-time) storage directories
      • 4.2.5. Launch Cyrus
      • 4.2.6. Send a test email
      • 4.2.7. Checking CardDAV and CardDAV
      • 4.2.8. Troubleshooting
    • 4.3. Upgrading to 3.0
      • 4.3.1. 1. Preparation
        • 4.3.1.1. Installation from tarball
        • 4.3.1.2. How are you planning on upgrading?
        • 4.3.1.3. Do What As Who?
      • 4.3.2. 2. Install new 3.0 Cyrus
      • 4.3.3. 3. Shut down existing Cyrus
      • 4.3.4. 4. Backup and Copy existing data
      • 4.3.5. 5. Copy config files and update
      • 4.3.6. 6. Upgrade specific items
      • 4.3.7. 7. Start new 3.0 Cyrus and verify
      • 4.3.8. 8. Reconstruct databases and cache
      • 4.3.9. 9. Do you want any new features?
      • 4.3.10. 10. Upgrade complete
      • 4.3.11. Special note for Murder configurations
    • 4.4. Configuration Guide
      • 4.4.1. Deployment Scenarios
        • 4.4.1.1. Single Server Deployments
        • 4.4.1.2. Multi Server Deployments
      • 4.4.2. Cyrus Murder: Server aggregation
        • 4.4.2.1. The Discrete Murder
        • 4.4.2.2. The Unified Murder
        • 4.4.2.3. The Shared Murder
      • 4.4.3. Cyrus Replication
      • 4.4.4. Hosted Environments
      • 4.4.5. Databases
        • 4.4.5.1. Overview
        • 4.4.5.2. File list
        • 4.4.5.3. Storage types
      • 4.4.6. Mailbox Creation Distribution
        • 4.4.6.1. Selection Mode
        • 4.4.6.2. Special cases
        • 4.4.6.3. Partitions Exclusion
        • 4.4.6.4. Partitions Usage Data Reset
        • 4.4.6.5. Mailbox Creation Distribution Through murder frontend
        • 4.4.6.6. Backends Exclusion
        • 4.4.6.7. Backends Usage Data Reset
      • 4.4.7. Known Protocol Limitations
        • 4.4.7.1. POP3 and Mailbox Locking
        • 4.4.7.2. Cyrus IMAP POP3 Implementation
      • 4.4.8. Authentication and Authorization
        • 4.4.8.1. Client Authentication
        • 4.4.8.2. Users and Mailboxes
      • 4.4.9. Performance Recommendations
        • 4.4.9.1. Databases on Temporary Filesystems
      • 4.4.10. Storage Considerations
        • 4.4.10.1. General Notes on Storage
        • 4.4.10.2. Redundancy
        • 4.4.10.3. Availability
        • 4.4.10.4. Performance
        • 4.4.10.5. Scalability
        • 4.4.10.6. Capacity
        • 4.4.10.7. Cost
      • 4.4.11. Supported Platforms and System Requirements
        • 4.4.11.1. Building Cyrus IMAP
        • 4.4.11.2. Required Software Components
        • 4.4.11.3. Recommended Software Components
        • 4.4.11.4. Recommended Software Components Enabled by Default
  • 5. Operations
    • 5.1. Man pages
      • 5.1.1. (5) Configuration Files
        • 5.1.1.1. cyrus.conf
        • 5.1.1.2. imapd.conf
        • 5.1.1.3. krb.equiv
      • 5.1.2. (8) System Commands
        • 5.1.2.1. arbitron
        • 5.1.2.2. backupd
        • 5.1.2.3. chk_cyrus
        • 5.1.2.4. ctl_backups
        • 5.1.2.5. ctl_conversationsdb
        • 5.1.2.6. ctl_cyrusdb
        • 5.1.2.7. ctl_deliver
        • 5.1.2.8. ctl_mboxlist
        • 5.1.2.9. ctl_zoneinfo
        • 5.1.2.10. cvt_cyrusdb
        • 5.1.2.11. cvt_xlist_specialuse
        • 5.1.2.12. cyr_backup
        • 5.1.2.13. cyr_buildinfo
        • 5.1.2.14. cyr_dbtool
        • 5.1.2.15. cyr_deny
        • 5.1.2.16. cyr_df
        • 5.1.2.17. cyr_expire
        • 5.1.2.18. cyr_info
        • 5.1.2.19. cyr_sequence
        • 5.1.2.20. cyr_synclog
        • 5.1.2.21. cyr_userseen
        • 5.1.2.22. cyr_virusscan
        • 5.1.2.23. cyradm
        • 5.1.2.24. cyrdump
        • 5.1.2.25. deliver
        • 5.1.2.26. fetchnews
        • 5.1.2.27. fud
        • 5.1.2.28. httpd
        • 5.1.2.29. idled
        • 5.1.2.30. imapd
        • 5.1.2.31. ipurge
        • 5.1.2.32. lmtpd
        • 5.1.2.33. lmtpproxyd
        • 5.1.2.34. masssievec
        • 5.1.2.35. master
        • 5.1.2.36. mbexamine
        • 5.1.2.37. mbpath
        • 5.1.2.38. mbtool
        • 5.1.2.39. mkimap
        • 5.1.2.40. mknewsgroups
        • 5.1.2.41. mupdate
        • 5.1.2.42. nntpd
        • 5.1.2.43. notifyd
        • 5.1.2.44. pop3d
        • 5.1.2.45. pop3proxyd
        • 5.1.2.46. proxyd
        • 5.1.2.47. ptdump
        • 5.1.2.48. ptexpire
        • 5.1.2.49. ptloader
        • 5.1.2.50. quota
        • 5.1.2.51. reconstruct
        • 5.1.2.52. rehash
        • 5.1.2.53. restore
        • 5.1.2.54. sievec
        • 5.1.2.55. sieved
        • 5.1.2.56. smmapd
        • 5.1.2.57. squatter
        • 5.1.2.58. sync_client
        • 5.1.2.59. sync_reset
        • 5.1.2.60. sync_server
        • 5.1.2.61. timsieved
        • 5.1.2.62. tls_prune
        • 5.1.2.63. translatesieve
        • 5.1.2.64. unexpunge
      • 5.1.3. (1) User Commands
        • 5.1.3.1. arbitronsort.pl
        • 5.1.3.2. dav_reconstruct
        • 5.1.3.3. httptest
        • 5.1.3.4. imtest
        • 5.1.3.5. installsieve
        • 5.1.3.6. lmtptest
        • 5.1.3.7. mupdatetest
        • 5.1.3.8. nntptest
        • 5.1.3.9. pop3test
        • 5.1.3.10. sieveshell
        • 5.1.3.11. sivtest
        • 5.1.3.12. smtptest
        • 5.1.3.13. synctest
    • 5.2. Administrator Guide
      • 5.2.1. Architecture
        • 5.2.1.1. System Architecture
      • 5.2.2. Management
        • 5.2.2.1. File & Directory Locations
        • 5.2.2.2. Ports and Sockets
        • 5.2.2.3. Access Control
        • 5.2.2.4. Quotas
        • 5.2.2.5. Cyrus Sieve
        • 5.2.2.6. Cyrus Backups
        • 5.2.2.7. Cyrus NNTP
        • 5.2.2.8. Cyrus Prot Layer
        • 5.2.2.9. Standard Operating Procedures
        • 5.2.2.10. Cyrus Event Source
        • 5.2.2.11. Monitoring
        • 5.2.2.12. Mailbox Distribution
        • 5.2.2.13. Cyrus Murder
        • 5.2.2.14. HOWTO: Using an NGINX IMAP Proxy
        • 5.2.2.15. Tweaking Cyrus IMAP
    • 5.3. Frequently Asked Questions
      • 5.3.1. Features
        • 5.3.1.1. Which database backend should I use for which databases?
        • 5.3.1.2. Duplicate Delivery Suppression
      • 5.3.2. Installation Problems
        • 5.3.2.1. Compilation errors about kssl.h and krb5.h on Red Hat Linux/Fedora
        • 5.3.2.2. Help! There must be an easier way to get all this going...
        • 5.3.2.3. OpenSSL Version Mismatches
        • 5.3.2.4. Libical v1.0.1 or v2.0
      • 5.3.3. Common Feature Requests
        • 5.3.3.1. Does the Cyrus Murder support High Availability configurations?
        • 5.3.3.2. Can I configure pop3d to log amount and size of messages fetched by user?
        • 5.3.3.3. How can I make CyrusSieve work with public shared folders?
        • 5.3.3.4. Can I have subfolders not appear under INBOX?
      • 5.3.4. Common Operational Questions
        • 5.3.4.1. How do I view ACLs on a mailbox?
        • 5.3.4.2. What annotations are available?
        • 5.3.4.3. Is it safe to put <configdirectory>/proc and <configdirectory>/lock on a tmpfs filesystem?
        • 5.3.4.4. How to enable core dumps
        • 5.3.4.5. Why can I not delete a mailbox as an admin user?
        • 5.3.4.6. When is What ... Deleted, Expired, Expunged or Purged?
        • 5.3.4.7. Why is deliver.db so large?
        • 5.3.4.8. I have multiple imapd-SERVICES configured and experience occasional freezes when I try to log in!
        • 5.3.4.9. How to run gdb on Cyrus components
        • 5.3.4.10. Cyrus delivers claims that the mailbox does not exist
        • 5.3.4.11. Why is mail being rejected with No Mailbox found due to MiXed CaSe incoming e-mail?
        • 5.3.4.12. Can I use MySQL (or another SQL database) as the primary mail store?
        • 5.3.4.13. Why do POP3 connections take so long, but once the connection is established all is well?
        • 5.3.4.14. Why does reconstruct -m not work?
        • 5.3.4.15. Shared File Systems GPFS for high availability
        • 5.3.4.16. How to enable telemetry
        • 5.3.4.17. The process count keeps growing!
        • 5.3.4.18. “unable to join environment” error
        • 5.3.4.19. Why does Cyrus set the MAIL FROM address of the sender of vacation responses to ‘<>’?
      • 5.3.5. Common Interoperability Problems
        • 5.3.5.1. Why does Cyrus reject 8-bit characters in the headers of my messages?
        • 5.3.5.2. Why does Cyrus reject messages with “bare newlines”?
        • 5.3.5.3. How do I get Cyrus Sieve to play nice with Exim?
        • 5.3.5.4. Why does mail delivery go slow or hang sometimes?
  • 6. Developers
    • 6.1. We need your help
    • 6.2. Contribute docs
      • 6.2.1. Overview
      • 6.2.2. Documentation Tools
      • 6.2.3. Building the files
      • 6.2.4. Submitting updates
        • 6.2.4.1. Using GitHub pull requests
        • 6.2.4.2. Patches through the mailing list
      • 6.2.5. Special Tags
        • 6.2.5.1. rfc
        • 6.2.5.2. cyrusman
        • 6.2.5.3. imap_current_stable_version
      • 6.2.6. Conventions: Man Pages
        • 6.2.6.1. Synopsis
        • 6.2.6.2. Examples
    • 6.3. Contribute code and tests
      • 6.3.1. Getting Started
        • 6.3.1.1. Development Process
        • 6.3.1.2. Overview of Cyrus development environment
        • 6.3.1.3. GitHub guide
        • 4.1. Compiling
        • 4.2. Installing Cyrus
        • 6.3.1.4. Developer Test Environment
        • 6.3.1.5. JMAP support
      • 6.3.2. System files and Databases
        • 6.3.2.1. Namespaces: a developer view
      • 6.3.3. Resources
        • 6.3.3.1. Developer Libraries
      • 6.3.4. Releasing
        • 6.3.4.1. Releasing Cyrus IMAP
        • 6.3.4.2. Releasing new builds of ancient Cyrus IMAP versions
    • 6.4. Cyrus.Works
      • 6.4.1. About Cyrus Works
      • 6.4.2. Testing
      • 6.4.3. How it works
      • 6.4.4. Adding Rules
    • 6.5. Cyrus Internals
      • 6.5.1. Cyrus APIs
        • 6.5.1.1. CyrusDB API
        • 6.5.1.2. cyrusdb API
        • 6.5.1.3. Index API
        • 6.5.1.4. Mailbox API
      • 6.5.2. Thoughts & Notes
        • 6.5.2.1. Notes for backup implementation
        • 6.5.2.2. Cyrus IMAP Server: Sieve Bytecode
        • 6.5.2.3. Cyrus CalDAV Scheduling Flowchart
        • 6.5.2.4. Enabling improved_mboxlist_sort
        • 6.5.2.5. Cyrus IMAP Server: Notes
        • 6.5.2.6. Cyrus IMAP Server: Prot Events
      • 6.5.3. Guidance for Developers
        • 6.5.3.1. Cyrus IMAP Server: Hacking
        • 6.5.3.2. Cyrus IMAP Server: Internationalization
        • 6.5.3.3. Cyrus IMAP Server: Locking
        • 6.5.3.4. Cyrus IMAP Server: Mailbox File Formats
        • 6.5.3.5. Cyrus IMAP Server: Namelocks
        • 6.5.3.6. Cyrus IMAP Server: prot layer
        • 6.5.3.7. Cyrus IMAP Server: Replication Examples
        • 6.5.3.8. Cyrus IMAP Server: Replication Protocol v2.4+
        • 6.5.3.9. Cyrus IMAP Server: Special Characters
        • 6.5.3.10. Cyrus IMAP Server: var directory structure
    • 6.6. Unit Tests
      • 6.6.1. Unit Tests
        • 6.6.1.1. Table of Contents
        • 6.6.1.2. 1. Introduction
        • 6.6.1.3. 2. What Is A Unit Test?
        • 6.6.1.4. 3. Running The Tests
        • 6.6.1.5. 3.6 Debugging A Test
        • 6.6.1.6. 4. Adding Your Own Tests
        • 6.6.1.7. 4.1 Where To Put Your Tests
        • 6.6.1.8. 4.1 Adding A New Suite
        • 6.6.1.9. 4.2 Adding A Test To A Suite
        • 6.6.1.10. 4.3 Suite Setup And Teardown
  • 7. Support/Community
    • 7.1. Found a bug?
    • 7.2. Mailing lists
      • 7.2.1. Archives
      • 7.2.2. Subscribe/Unsubscribe
      • 7.2.3. Digest Lists
    • 7.3. IRC
    • 7.4. Weekly meetings
    • 7.5. About
      • 7.5.1. What is Cyrus
        • 7.5.1.1. What is Cyrus
        • 7.5.1.2. What is IMAP?
        • 7.5.1.3. IMAP Version 4 (IMAP4)
        • 7.5.1.4. Mime
        • 7.5.1.5. SMTP
      • 7.5.2. Who Is Cyrus
        • 7.5.2.1. Core Contributors
        • 7.5.2.2. Individual contributors and past contributors
      • 7.5.3. Cyrus Roadmap
        • 7.5.3.1. High Level Roadmap
      • 7.5.4. Cyrus History
      • 7.5.5. Cyrus Bylaws
        • 7.5.5.1. I. The Cyrus Governance Board
        • 7.5.5.2. II. The Cyrus Core Developers Group
        • 7.5.5.3. III. The Release Engineer
        • 7.5.5.4. IV. The Cyrus Roadmap
        • 7.5.5.5. V. Development Process
        • 7.5.5.6. VI. Changes to the Bylaws

Cyrus SASL

  • Cyrus SASL
master:
 
Cyrus IMAP
  • Docs v3.1.6 (dev) »
  • 6. Developers »
  • 6.3. IMAP Developer Guide
  • Edit on GitHub

6.3. IMAP Developer Guide¶

6.3.1. Getting Started¶

  • 6.3.1.1. Development Process
  • 6.3.1.2. Overview of Cyrus development environment
  • 6.3.1.3. GitHub guide
  • 4.1. Compiling
  • 4.2. Installing Cyrus
  • 6.3.1.4. Developer Test Environment
  • 6.3.1.5. JMAP support

6.3.2. System files and Databases¶

  • 6.3.2.1. Namespaces: a developer view

6.3.3. Resources¶

  • 6.3.3.1. Developer Libraries

6.3.4. Releasing¶

  • 6.3.4.1. Releasing Cyrus IMAP
    • 6.3.4.1.1. Prerequisites
    • 6.3.4.1.2. Release notes
    • 6.3.4.1.3. Pre-release testing
    • 6.3.4.1.4. Linking up release notes
    • 6.3.4.1.5. Version tagging
    • 6.3.4.1.6. Releasing
  • 6.3.4.2. Releasing new builds of ancient Cyrus IMAP versions
    • 6.3.4.2.1. Introduction
    • 6.3.4.2.2. Prerequisites
    • 6.3.4.2.3. Release notes and version update
    • 6.3.4.2.4. Pre-release testing
    • 6.3.4.2.5. Cross-pollination of release notes
    • 6.3.4.2.6. Building the release
    • 6.3.4.2.7. Releasing
Next Previous

© Copyright 1993-2018, The Cyrus Team. Last updated on Aug 13 2018

Built with Sphinx 1.3.6 using a modified Read the Docs theme.