Sitemap

• What is Cyrus IMAP?
  • Download
    • Get Cyrus
      • Distribution Package
      • Build and Install Yourself
        • Use a release packaged tarball
        • Use the source from Git
      • Licensing
    • Release Notes
      • Current Development
        • Series 3.14
          • Cyrus IMAP 3.13 Snapshots
            • Cyrus IMAP 3.13.0-alpha0 Tag Notes
      • Supported Verions
        • Series 3.12
          • Cyrus IMAP 3.12 Releases
            • Cyrus IMAP 3.12.0-alpha0 Release Notes
            • Cyrus IMAP 3.12.0-beta1 Release Notes
            • Cyrus IMAP 3.12.0-beta2 Release Notes
            • Cyrus IMAP 3.12.0-rc1 Release Notes
          • Cyrus IMAP 3.11 Snapshots
            • Cyrus IMAP 3.11.0-alpha0 Tag Notes
        • Series 3.10
          • Cyrus IMAP 3.10 Releases
            • Cyrus IMAP 3.10.0-alpha0 Release Notes
            • Cyrus IMAP 3.10.0-beta1 Release Notes
            • Cyrus IMAP 3.10.0-beta2 Release Notes
            • Cyrus IMAP 3.10.0-rc1 Release Notes
            • Cyrus IMAP 3.10.0-rc2 Release Notes
            • Cyrus IMAP 3.10.0 Release Notes
            • Cyrus IMAP 3.10.1 Release Notes
          • Cyrus IMAP 3.9 Snapshots
            • Cyrus IMAP 3.9.0-alpha0 Tag Notes
        • Series 3.8
          • Cyrus IMAP 3.8 Releases
            • Cyrus IMAP 3.8.0-alpha0 Release Notes
            • Cyrus IMAP 3.8.0-beta1 Release Notes
            • Cyrus IMAP 3.8.0-beta2 Release Notes
            • Cyrus IMAP 3.8.0-rc1 Release Notes
            • Cyrus IMAP 3.8.0 Release Notes
            • Cyrus IMAP 3.8.1 Release Notes
            • Cyrus IMAP 3.8.2 Release Notes
            • Cyrus IMAP 3.8.3 Release Notes
            • Cyrus IMAP 3.8.4 Release Notes
            • Cyrus IMAP 3.8.5 Release Notes
          • Cyrus IMAP 3.7 Snapshots
            • Cyrus IMAP 3.7.0-alpha0 Tag Notes
      • Older Versions
        • Series 3.x
          • Cyrus IMAP 3.6 Releases
            • Cyrus IMAP 3.6.0-beta1 Release Notes
            • Cyrus IMAP 3.6.0-beta2 Release Notes
            • Cyrus IMAP 3.6.0-beta3 Release Notes
            • Cyrus IMAP 3.6.0-rc1 Release Notes
            • Cyrus IMAP 3.6.0-rc2 Release Notes
            • Cyrus IMAP 3.6.0 Release Notes
            • Cyrus IMAP 3.6.1 Release Notes
            • Cyrus IMAP 3.6.2 Release Notes
            • Cyrus IMAP 3.6.3 Release Notes
            • Cyrus IMAP 3.6.4 Release Notes
            • Cyrus IMAP 3.6.5 Release Notes
            • Cyrus IMAP 3.6.6 Release Notes
            • Cyrus IMAP 3.6.7 Release Notes
          • Cyrus IMAP 3.5 Snapshots
            • Cyrus IMAP 3.5.0-alpha0 Tag Notes
          • Cyrus IMAP 3.4 Releases
            • Cyrus IMAP 3.4.0-beta1 Release Notes
            • Cyrus IMAP 3.4.0-beta2 Release Notes
            • Cyrus IMAP 3.4.0-beta3 Release Notes
            • Cyrus IMAP 3.4.0-rc1 Release Notes
            • Cyrus IMAP 3.4.0 Release Notes
            • Cyrus IMAP 3.4.1 Release Notes
            • Cyrus IMAP 3.4.2 Release Notes
            • Cyrus IMAP 3.4.3 Release Notes
            • Cyrus IMAP 3.4.4 Release Notes
            • Cyrus IMAP 3.4.5 Release Notes
            • Cyrus IMAP 3.4.6 Release Notes
            • Cyrus IMAP 3.4.7 Release Notes
            • Cyrus IMAP 3.4.8 Release Notes
            • Cyrus IMAP 3.4.9 Release Notes
          • Cyrus IMAP 3.3 Snapshots
            • Cyrus IMAP 3.3.0 Tag Notes
            • Cyrus IMAP 3.3.1 Tag Notes
          • Cyrus IMAP 3.2 Releases
            • Cyrus IMAP 3.2.0-beta3 Release Notes
            • Cyrus IMAP 3.2.0-beta4 Release Notes
            • Cyrus IMAP 3.2.0-rc1 Release Notes
            • Cyrus IMAP 3.2.0 Release Notes
            • Cyrus IMAP 3.2.1 Release Notes
            • Cyrus IMAP 3.2.10 Release Notes
            • Cyrus IMAP 3.2.11 Release Notes
            • Cyrus IMAP 3.2.12 Release Notes
            • Cyrus IMAP 3.2.2 Release Notes
            • Cyrus IMAP 3.2.3 Release Notes
            • Cyrus IMAP 3.2.4 Release Notes
            • Cyrus IMAP 3.2.5 Release Notes
            • Cyrus IMAP 3.2.6 Release Notes
            • Cyrus IMAP 3.2.7 Release Notes
            • Cyrus IMAP 3.2.8 Release Notes
            • Cyrus IMAP 3.2.9 Release Notes
          • Cyrus IMAP 3.1 Snapshots
            • Cyrus IMAP 3.1.0-dev Release Notes
            • Cyrus IMAP 3.1.1 Tag Notes
            • Cyrus IMAP 3.1.2 Tag Notes
            • Cyrus IMAP 3.1.3 Tag Notes
            • Cyrus IMAP 3.1.4 Tag Notes
            • Cyrus IMAP 3.1.5 Tag Notes
            • Cyrus IMAP 3.1.6 Tag Notes
            • Cyrus IMAP 3.1.7 Tag Notes
            • Cyrus IMAP 3.1.8 Tag Notes
            • Cyrus IMAP 3.1.9 Tag Notes
          • Cyrus IMAP 3.0 Releases
            • Cyrus IMAP 3.0.0 beta1 Release Notes
            • Cyrus IMAP 3.0.0 beta2 Release Notes
            • Cyrus IMAP 3.0.0 beta3 Release Notes
            • Cyrus IMAP 3.0.0 beta4 Release Notes
            • Cyrus IMAP 3.0.0 beta5 Release Notes
            • Cyrus IMAP 3.0.0 beta6 Release Notes
            • Cyrus IMAP 3.0.0 rc1 Release Notes
            • Cyrus IMAP 3.0.0 rc2 Release Notes
            • Cyrus IMAP 3.0.0 rc3 Release Notes
            • Cyrus IMAP 3.0.0 rc4 Release Notes
            • Cyrus IMAP 3.0.0 Release Notes
            • Cyrus IMAP 3.0.1 Release Notes
            • Cyrus IMAP 3.0.10 Release Notes
            • Cyrus IMAP 3.0.11 Release Notes
            • Cyrus IMAP 3.0.12 Release Notes
            • Cyrus IMAP 3.0.13 Release Notes
            • Cyrus IMAP 3.0.14 Release Notes
            • Cyrus IMAP 3.0.15 Release Notes
            • Cyrus IMAP 3.0.16 Release Notes
            • Cyrus IMAP 3.0.17 Release Notes
            • Cyrus IMAP 3.0.18 Release Notes
            • Cyrus IMAP 3.0.2 Release Notes
            • Cyrus IMAP 3.0.3 Release Notes
            • Cyrus IMAP 3.0.4 Release Notes
            • Cyrus IMAP 3.0.5 Release Notes
            • Cyrus IMAP 3.0.6 Release Notes
            • Cyrus IMAP 3.0.7 Release Notes
            • Cyrus IMAP 3.0.8 Release Notes
            • Cyrus IMAP 3.0.9 Release Notes
        • Series 2.x
          • Cyrus IMAP 2.5 Releases
            • Cyrus IMAP 2.5.0 Release Notes
            • Cyrus IMAP 2.5.1 Release Notes
            • Cyrus IMAP 2.5.2 Release Notes
            • Cyrus IMAP 2.5.3 Release Notes
            • Cyrus IMAP 2.5.4 Release Notes
            • Cyrus IMAP 2.5.5 Release Notes
            • Cyrus IMAP 2.5.6 Release Notes
            • Cyrus IMAP 2.5.7 Release Notes
            • Cyrus IMAP 2.5.8 Release Notes
            • Cyrus IMAP 2.5.9 Release Notes
            • Cyrus IMAP 2.5.10 Release Notes
            • Cyrus IMAP 2.5.11 Release Notes
            • Cyrus IMAP 2.5.12 Release Notes
            • Cyrus IMAP 2.5.13 Release Notes
            • Cyrus IMAP 2.5.15 Release Notes
            • Cyrus IMAP 2.5.16 Release Notes
            • Cyrus IMAP 2.5.17 Release Notes
          • Cyrus IMAP 2.4 Releases
            • Cyrus IMAP 2.4.0 Release Notes
            • Cyrus IMAP 2.4.1 Release Notes
            • Cyrus IMAP 2.4.2 Release Notes
            • Cyrus IMAP 2.4.3 Release Notes
            • Cyrus IMAP 2.4.4 Release Notes
            • Cyrus IMAP 2.4.5 Release Notes
            • Cyrus IMAP 2.4.6 Release Notes
            • Cyrus IMAP 2.4.7 Release Notes
            • Cyrus IMAP 2.4.8 Release Notes
            • Cyrus IMAP 2.4.9 Release Notes
            • Cyrus IMAP 2.4.10 Release Notes
            • Cyrus IMAP 2.4.11 Release Notes
            • Cyrus IMAP 2.4.12 Release Notes
            • Cyrus IMAP 2.4.13 Release Notes
            • Cyrus IMAP 2.4.14 Release Notes
            • Cyrus IMAP 2.4.15 Release Notes
            • Cyrus IMAP 2.4.16 Release Notes
            • Cyrus IMAP 2.4.17 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta1 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta10 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta11 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta2 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta3 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta4 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta5 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta6 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta7 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta8 Release Notes
            • Cyrus IMAP 2.4.17-caldav-beta9 Release Notes
            • Cyrus IMAP 2.4.18 Release Notes
            • Cyrus IMAP 2.4.19 Release Notes
            • Cyrus IMAP 2.4.20 Release Notes
            • Cyrus IMAP 2.4.21 Release Notes
            • Cyrus IMAP 2.4.22 Release Notes
          • Cyrus IMAP 2.3 Releases
            • Cyrus IMAP 2.3.0 Release Notes
            • Cyrus IMAP 2.3.1 Release Notes
            • Cyrus IMAP 2.3.2 Release Notes
            • Cyrus IMAP 2.3.3 Release Notes
            • Cyrus IMAP 2.3.4 Release Notes
            • Cyrus IMAP 2.3.5 Release Notes
            • Cyrus IMAP 2.3.6 Release Notes
            • Cyrus IMAP 2.3.7 Release Notes
            • Cyrus IMAP 2.3.8 Release Notes
            • Cyrus IMAP 2.3.9 Release Notes
            • Cyrus IMAP 2.3.10 Release Notes
            • Cyrus IMAP 2.3.11 Release Notes
            • Cyrus IMAP 2.3.12 Release Notes
            • Cyrus IMAP 2.3.13 Release Notes
            • Cyrus IMAP 2.3.14 Release Notes
            • Cyrus IMAP 2.3.15 Release Notes
            • Cyrus IMAP 2.3.16 Release Notes
            • Cyrus IMAP 2.3.17 Release Notes
            • Cyrus IMAP 2.3.18 Release Notes
            • Cyrus IMAP 2.3.19 Release Notes
            • Cyrus IMAP 2.3.20 Release Notes
          • Cyrus IMAP 2.2 Releases
          • Cyrus IMAP 2.1 Releases
          • Cyrus IMAP 2.0 Releases
        • Series 1.x
          • Cyrus IMAP 1.x Release Notes
    • Notes for Packagers
      • Binary naming
      • Sample configuration files
      • Predefined configurations
        • The configuration file for master: cyrus.conf
          • Section Purpose
        • The configuration file for the various programs: imapd.conf
          • Ephemeral files and temporary filesystems
          • New default settings
          • New or improved features
      • Services in /etc/services
  • Quickstart Guide
    • Introduction to Cyrus IMAP
      • What is IMAP?
    • Quick install
      • 1. Install Cyrus package(s)
      • 2. Setup the cyrus:mail user and group
      • 3. Setting up authentication with SASL
      • 4. Setup mail delivery from your MTA
      • 5. Protocol ports
      • 6. Configuring Cyrus
      • 7. Launch Cyrus
  • Overview
    • Features
      • Security and Authentication
        • Kerberos Authentication
        • LDAP Authentication
        • SQL Authentication
          • Pre-requisites
            • MySQL Server
            • saslauthd
            • pam_mysql
          • Database structure
          • PAM configuration for use with saslauthd
          • Testing the SASL configuration
          • Create the test mailboxes within Cyrus
          • Testing everything together
        • Access Control
        • Sealed System Design
      • Mailbox Management
        • Automatic Creation of Mailboxes
          • Autocreation of mailboxes
          • Automatic quota settings
          • Autocreation of Sieve scripts
          • Automated folder subscriptions
          • Autocreation of users
            • Limitations to the Automatic Creation of Mailboxes
        • Mailbox Namespaces
          • Namespace Basics
          • User Access Namespaces
          • User Namespace Mode
          • Administrator Namespaces
        • Virtual Domains
          • What are virtual domains?
          • Concepts
          • Quick Start
          • Configuration
            • Multiple IP Addresses
            • Delivering mail
            • Mail Clients
            • Administrators
        • Mailbox Annotations (METADATA)
        • Mailbox Distribution
          • Partition Selection Mode
          • Backend Selection Mode (Cyrus IMAP Murder)
      • Message Management
        • Delayed Delete
          • Configuring Cyrus IMAP for Delayed Delete
        • Delayed Expunge
          • Configuring Cyrus IMAP for Delayed Expunge
        • Message Annotations (METADATA)
        • Duplicate Message Delivery Suppression
        • Shared Seen State
        • Server Side Filtering (Sieve)
        • Event Notifications
          • Available Event Notifications
          • Example Event Notifications
            • AclChange
            • FlagsClear
            • FlagsSet
            • Login
            • Logout
            • MailboxCreate
            • MailboxDelete
            • MailboxRename
            • MailboxSubscribe
            • MailboxUnSubscribe
            • MessageAppend
            • MessageCopy
            • MessageExpire
            • MessageExpunge
            • MessageMove
            • MessageNew
            • MessageRead
            • MessageTrash
            • QuotaChange
            • QuotaExceed
            • QuotaWithin
            • CalendarAlarm
            • ApplePushService
      • Calendar and Contact (DAV) Collection Management
        • CalDAV Collections
        • DAV Components
        • DAV Collection Management
        • CardDAV Support
      • Storage
        • Mail Spool Partitions
          • Storage Tiering with Partitions
          • Restricting Storage Used with Partitions
        • Mailbox Metadata Partitions
        • Archiving
          • Description
          • Purpose
          • Enabling
          • Defining
          • Controlling
          • Performing
        • Quota
        • Single-Instance Store
      • Load Management
        • Cyrus IMAP Murder (Server Aggregation)
          • Use-Cases for the Cyrus IMAP Murder
          • Cyrus IMAP Murder Topologies
            • Discrete Murder
            • Replicated Murder
            • Unified Murder
    • Concepts
      • Access Control Lists
        • Working with ACLs
        • Sample ACL
        • Access Rights
        • Access Control Defaults
          • Administrators
          • Mailbox owners
          • Default
          • Initial ACLs for Newly Created Mailboxes
          • Other Implicit Rights
        • Access Control Identifier (ACI)
          • anonymous and anyone
        • Negative Rights
        • Calculating a Users' Rights
      • Login Authentication
        • Anonymous Login
        • Plaintext Authentication
        • Kerberos Logins
        • Shared Secrets Logins
      • Quotas
        • Working with Quotas
        • Monitor and Repair
        • Supported Quota Types
          • Storage Quotas
          • Numeric Quotas
        • Quota Roots
        • Controlling Quota Behavior
        • Mail Delivery Behavior
          • Mailboxes Near Quota
          • Mailboxes Over Quota
        • Quota Warnings Upon Select When User Has d Rights
        • Quotas and Partitions
      • New Mail Notification
      • Partitions
        • Specifying Partitions with "create"
        • Changing Partitions with "rename"
      • News
      • POP3 Server
      • The syslog facility
      • Mail Directory Recovery
        • Reconstructing Mailbox Directories
        • Reconstructing the Mailboxes File
        • Reconstructing Quota Roots
        • Removing Quota Roots
        • Subscriptions
      • Configuration Directory
        • Log Directory
        • Proc Directory
      • Message Delivery
        • Local Mail Transfer Protocol (lmtp)
        • Single Instance Store
        • Duplicate Delivery Suppression
      • Sieve, a Mail Filtering Language
      • Cyrus Murder, the IMAP Aggregator
  • Setup
    • Compiling
      • Setting up dependencies
        • Required Build Dependencies
        • Build dependencies for additional functionality
          • Developers only
          • SASL Authentication
          • Alternate database formats
          • CalDAV, CardDAV, or JMAP (httpd subsystem)
          • Other
      • Compile Cyrus
        • Default build: mail only
        • Optional dependencies
          • CalDAV, CardDAV, WebDAV, JMAP
          • Murder
          • Replication
        • Compile
        • Check
    • Installing Cyrus
      • Install Cyrus
      • Optional Components
        • HTTP modules
          • About http module support
          • HTTPD Configuration
            • General configuration
            • Authentication
          • Module-specific information
            • CalDAV
            • CardDAV
            • WebDAV
            • JMAP
            • RSS Feeds
          • For end users
        • Virus Scanner
          • About virus scan support
          • Virus Scanner Configuration
            • General configuration
            • ClamAV
      • Setting up syslog
      • Create Cyrus environment
        • Set up the cyrus:mail user and group
        • Authentication with SASL
        • Mail delivery from your MTA
          • Integration with Sendmail
            • Objectives
            • Install Sendmail
            • Add cf/feature/anfi_vcyrus.m4
            • Patching m4/proto.m4
            • Patching mailer/cyrusv2.m4
            • Sendmail communication
            • Adjustments for the .mc files
          • Postfix
            • Install Postfix
        • Protocol ports
        • Cyrus config files
        • Optional: Setting up TLS certificates
        • Prepare ephemeral (run-time) storage directories
      • Launch Cyrus
      • Send a test email
      • Checking CardDAV and CalDAV
      • Troubleshooting
    • Upgrading to 3.12
      • 1. Preparation
        • Versions to upgrade from
        • Installation from tarball
        • JMAP/CalDAV changes
          • New JMAP Email/query filter conditions
        • PCRE2 support
        • How are you planning on upgrading?
          • Upgrade by replicating
          • Upgrade in place
        • Do What As Who?
      • 2. Install new 3.12 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.12 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
        • Single Server Deployments
        • Multi Server Deployments
          • Cyrus IMAP Murder
          • IMAP Proxy
      • Cyrus Murder: Server aggregation
        • The Discrete Murder
        • The Unified Murder
        • The Shared Murder
      • Cyrus Replication
      • Hosted Environments
      • Databases
        • Overview
        • File list
          • Mailbox List (mailboxes.db)
          • Annotations (annotations.db)
          • Quotas (quotas.db)
          • Duplicate Delivery (deliver.db)
          • TLS cache (tls_sessions.db)
          • PTS cache (ptscache.db)
          • STATUS cache (statuscache.db)
          • User Access (user_deny.db)
          • Conversations (<userid>.conversations)
          • Counters (<userid>.counters)
          • News database (fetchnews.db)
          • Search Indexes (cyrus.squat, <userid>.xapianactive, cyrus.indexed.db)
          • Zoneinfo db (zoneinfo.db)
          • Seen State (<userid>.seen)
          • Subscriptions (<userid>.sub)
          • Search Index DB List (<userid>.xapianactive)
          • Mailbox Keys (<userid>.mboxkey)
          • DAV Index (<userid>.dav)
            • CalDAV
            • CardDAV
            • Sieve
        • Storage types
          • Flat
          • Twom
          • Twoskip
          • Skiplist
          • sql
          • quotalegacy
      • Mailbox Creation Distribution
        • Selection Mode
          • Available Selection Modes
          • Usage convergence
          • Computed weight
        • Special cases
          • What happens when two partitions are equal as most fitting?
          • What happens when two partitions point to the same device?
        • Partitions Exclusion
        • Partitions Usage Data Reset
        • Mailbox Creation Distribution Through murder frontend
          • Selection Mode
          • Available Selection Modes on Frontend
        • Backends Exclusion
        • Backends Usage Data Reset
      • Known Protocol Limitations
        • POP3 and Mailbox Locking
        • Cyrus IMAP POP3 Implementation
      • Authentication and Authorization
        • Client Authentication
        • Users and Mailboxes
      • Performance Recommendations
        • Databases on Temporary Filesystems
        • Certificates
      • Storage Considerations
        • General Notes on Storage
        • Redundancy
        • Availability
        • Performance
        • Scalability
        • Capacity
        • Cost
      • Supported Platforms and System Requirements
        • Building Cyrus IMAP
        • Required Software Components
        • Recommended Software Components
          • Idled Support
          • Murder Support
          • Replication Support
        • Recommended Software Components Enabled by Default
          • Sieve Support
          • Optional Software Components
  • Operations
    • Man pages
      • (5) Configuration Files
        • cyrus.conf
          • Description
          • Section Descriptions
            • START
            • SERVICES
            • EVENTS
            • DAEMON
          • Examples
          • Access Control
          • See Also
        • imapd.conf
          • DESCRIPTION
          • FIELD DESCRIPTIONS
          • SEE ALSO
      • (8) System Commands
        • arbitron
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • calalarmd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • chk_cyrus
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • ctl_conversationsdb
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • ctl_cyrusdb
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • ctl_deliver
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
          • Files
        • ctl_mboxlist
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • ctl_zoneinfo
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • cvt_cyrusdb
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • cvt_xlist_specialuse
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • cyr_buildinfo
          • Synopsis
          • Description
          • Options
        • cyr_dbtool
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • cyr_deny
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • cyr_df
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • cyr_expire
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • cyr_info
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • cyr_ls
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • cyr_synclog
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • cyr_userseen
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • cyr_virusscan
          • Synopsis
          • Description
          • Options
          • Notifications
          • Examples
          • History
          • Files
          • See Also
        • cyr_withlock_run
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • Environment
          • See Also
        • cyradm
          • NAME
          • SYNOPSIS
          • DESCRIPTION
          • COMMAND-LINE ARGUMENTS
          • COMMANDS
            • authenticate
            • chdir
            • createmailbox
            • deleteaclmailbox
            • deletemailbox
            • disconnect
            • exit
            • help
            • getmetadata
            • info
            • listaclmailbox
            • listmailbox
            • listquota
            • listquotaroot
            • mboxconfig
            • reconstruct
            • renamemailbox
            • server
            • setaclmailbox
            • setinfo
            • setmetadata
            • setquota
            • subscribe
            • unsubscribe
            • version
            • xfermailbox
          • NOTES
          • AUTHOR
          • SEE ALSO
        • cyrdump
          • Synopsis
          • Description
          • Options
        • deliver
          • Synopsis
          • Description
          • Options
          • NOTES
          • Examples
          • Files
          • See Also
        • fetchnews
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • fud
          • Synopsis
          • Description
            • Client
          • Options
          • Files
          • Bugs
          • See Also
        • httpd
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • idled
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • imapd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • ipurge
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • lmtpd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • lmtpproxyd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • masssievec
          • Synopsis
          • Description
          • Options
          • See Also
        • master
          • Synopsis
          • Description
          • Options
          • Configuration
          • Notes
          • Files
          • See Also
        • mbexamine
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • mbpath
          • Synopsis
          • Description
          • Options
          • Selectors
          • Examples
          • Files
          • See Also
        • mbtool
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • mkimap
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • mknewsgroups
          • Synopsis
          • Description
          • Options
        • mupdate
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • nntpd
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • notifyd
          • Synopsis
          • Description
          • Options
          • NOTIFICATION METHODS
          • Files
          • See Also
        • pop3d
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • pop3proxyd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • promstatsd
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • proxyd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • ptdump
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • ptexpire
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • ptloader
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • quota
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • reconstruct
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • rehash
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • relocate_by_id
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • sievec
          • Synopsis
          • Description
          • Options
          • See Also
        • sieved
          • Synopsis
          • Description
          • Options
          • See Also
        • smmapd
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • squatter
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • sync_client
          • Synopsis
          • Description
          • Options
          • Examples
          • History
          • Files
          • See Also
        • sync_reset
          • Synopsis
          • Description
          • Options
          • Files
          • See Also
        • sync_server
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • timsieved
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • tls_prune
          • Synopsis
          • Description
          • Description
          • Options
          • Files
          • See Also
        • translatesieve
          • Synopsis
          • Description
          • Options
          • See Also
        • unexpunge
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
      • (1) User Commands
        • arbitronsort.pl
          • Synopsis
          • Description
          • Example
          • See Also
        • dav_reconstruct
          • Synopsis
          • Description
          • Options
        • httptest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • imtest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • installsieve
          • Synopsis
          • Description
          • Options
          • History
          • See Also
        • lmtptest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • mupdatetest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • nntptest
        • pop3test
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • sieveshell
          • NAME
          • SYNOPSIS
          • DESCRIPTION
          • OPTIONS
          • REFERENCES
          • AUTHOR
        • sivtest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • smtptest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • synctest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
    • Administrator Guide
      • Architecture
        • System Architecture
          • High Level Architecture
          • Cyrus Murder
          • Replication
            • Channels
            • Log file
          • Invoking Cyrus
            • imapd.conf
            • cyrus.conf
      • Management
        • File & Directory Locations
          • Archive Partitions
          • Configuration file locations
            • State Databases
          • State Directories
          • Per-user State Directories
          • Directory Hashing
          • Spool Directories
            • Default Spool location
            • Additional Spool locations
          • Metadata Partitions
          • Search Tiers
            • Default Search Tier Name
            • Search Tier Partition Location
          • Partitions
            • Types of Partitions
          • Working With Partitions
            • Mail Spool Partitions
            • Metadata Partitions
            • Archive Partitions
            • Search Partitions
        • Ports and Sockets
          • Cyrus Service Definitions
            • Controlling Service Ports and Sockets
          • Cyrus Socket Locations
            • Controlling Socket Locations
        • Access Control
          • Combining Access Rights
            • lrs
            • lirstw
            • ACL "Macros"
            • Features and Combined Access Rights
          • Access Control Defaults
            • Administrators
            • Mailbox owners
            • Default
            • Initial ACLs for Newly Created Mailboxes
            • Other Implicit Rights
          • Access Control Identifier (ACI)
            • anonymous and anyone
          • Authorization Mechanisms
            • Unix Authorization
            • mboxgroups Authorization
            • Kerberos Authorization
            • PTS Authorization
          • Access Control Lists Rights Reference
          • Discretionary Access Control
        • Quotas
          • Quota Roots
          • Supported Quota Types
            • Storage Quotas
            • Numeric Quotas
          • Monitor and Repair
          • Controlling Quota Behavior
          • Quota Database
          • Converting Quotas Database
        • Cyrus Sieve
          • Introduction
          • Installing Sieve
            • Configure sieve
            • Configure outgoing mail
          • Managing Sieve Scripts
            • Sieve scripts in shared folders
          • Testing the Sieve Server
          • Cyrus Sieve Support
            • Special use folders
            • Supported extensions
            • Cyrus IMAP Specific Extensions
            • Sieve Tools
          • Writing Sieve
        • Cyrus NNTP
          • Overview
          • NNTP Setup
          • Defining Newsgroups
            • Using Cyradm
          • Configuration
            • Push (traditional) feeds
            • Pull (suck) feeds
            • imapfeed
            • Control Messages
            • Reading/Posting articles
            • News clients
            • Email clients
            • Expiring articles
          • Further information
        • Cyrus Prot Layer
          • Events
            • The API
        • Standard Operating Procedures
          • Replication: Installation and Administration
            • Architecture
            • Terminology
            • Operating Modes
            • Transport
            • Installation
            • Channels
            • Other Considerations
            • Administration
          • Mailbox Operations
            • Determining the size of a mailbox
          • Reloading Cyrus IMAP Services
          • Alternative Namespace
            • Switching the Alternative Namespace
          • Deleting and Undeleting Messages and Folders
            • Terminology & Definitions
            • Expiring Deleted Messages and Folders
            • Undeleting Folders
            • Undeleting messages in a mailbox
          • Running Cyrus IMAP Services on Non-Standard Ports
            • Globally changing the service port
            • Changing the service port just for Cyrus
            • Security Enhanced Linux
          • Reconstructing Mailboxes
            • Individual mailboxes or folders
            • Recovering a complete spool directory
          • Using Squatter for Faster IMAP SEARCH
            • Squatter Invocation
            • Generating the Search Indexes
          • Splitting Metadata from Partitions
          • Managing user_deny.db
        • Cyrus Event Source
          • Overview
          • Compile options
          • Configuration options
          • Event Types
          • Accessing events
          • Apple Push Service
        • Monitoring
          • Setup
          • Configuration options
        • Mailbox Distribution
          • Selection Modes
            • Available Selection Modes
            • Guidelines
          • Special cases
            • What happens when two items are equal as most fitting ?
            • What happens when two items are actually the same ?
            • Items Exclusion
            • Items Usage Data Reset
          • Application
            • On backend
            • On frontend
            • Backends Exclusion
        • Cyrus Murder
          • Cyrus Murder: Concepts
            • Overview
            • Architecture
            • Implementation
            • Analysis
            • Futures
            • Appendices
          • Cyrus Murder: Installation and Administration
            • Architecture
            • Terminology
            • Installation
            • Administration
            • Gotchas
            • Troubleshooting
          • Cyrus Murder Mupdate Details
            • Participants
            • Data Formats
            • Server Responses
            • Server Initial Response
            • Commands
            • Database Synchronization
          • Cyrus Murder Failure Modes
            • What happens when the Murder mupdate master is unavailable?
            • What happens when the Murder mupdate master is available again?
            • What if my mupdate master blows up and I have to recover it?
          • Cyrus Murder Mail Delivery
            • Standard Way
            • Query local mailboxes.db
            • Contact local mupdate server
        • Tweaking Cyrus IMAP
          • Storage Tiering
            • Partitioning the Mail Spool
            • Distributing the Mail Spool
            • Using Metadata Partitions
          • Synchronous File Operations
            • Mailbox locking
    • Frequently Asked Questions
      • Features
        • Which database backend should I use for which databases?
        • Duplicate Delivery Suppression
      • Installation Problems
        • Compilation errors about kssl.h and krb5.h on Red Hat Linux/Fedora
        • Help! There must be an easier way to get all this going...
        • OpenSSL Version Mismatches
      • Common Feature Requests
        • Does the Cyrus Murder support High Availability configurations?
        • Can I configure pop3d to log amount and size of messages fetched by user?
        • How can I make CyrusSieve work with public shared folders?
        • Can I have subfolders not appear under INBOX?
      • Common Operational Questions
        • How do I view ACLs on a mailbox?
        • What annotations are available?
        • Is it safe to put <configdirectory>/proc and <configdirectory>/lock on a tmpfs filesystem?
        • How to enable core dumps
        • Why can I not delete a mailbox as an admin user?
        • When is What ... Deleted, Expired, Expunged or Purged?
          • Users and IMAP Clients Deleting Messages
            • Flagged As \Deleted
            • Moved to Trash Folder
            • Expunged Messages
          • Deleting Folders
          • Where are the Messages?
        • Why is deliver.db so large?
        • I have multiple imapd-SERVICES configured and experience occasional freezes when I try to log in!
        • How to run gdb on Cyrus components
        • Cyrus delivers claims that the mailbox does not exist
        • Why is mail being rejected with No Mailbox found due to MiXed CaSe incoming e-mail?
        • Can I use MySQL (or another SQL database) as the primary mail store?
        • Why do POP3 connections take so long, but once the connection is established all is well?
        • Why does reconstruct -m not work?
        • Shared File Systems GPFS for high availability
        • How to enable telemetry
        • The process count keeps growing!
          • 1. Reuse count
          • 2. Maximum child count
          • 3. Clean up connections that are no longer in use
        • "unable to join environment" error
        • Why does Cyrus set the MAIL FROM address of the sender of vacation responses to '<>'?
      • Common Interoperability Problems
        • Why does Cyrus reject 8-bit characters in the headers of my messages?
        • Why does Cyrus reject messages with "bare newlines"?
        • How do I get Cyrus Sieve to play nice with Exim?
        • Why does mail delivery go slow or hang sometimes?
  • Developer Resources
    • The Development Process
      • Contributing to the documentation
        • Overview
        • Special Tags
          • rfc
          • cyrusman
          • imap_current_stable_version
        • Conventions: Man Pages
          • Synopsis
          • Examples
      • Contributing code and tests
        • Getting Started
          • Development Process
            • Making changes
            • Useful Developer Information
            • Community Participation
          • Overview of Cyrus development environment
            • cyrus-docker, cyd, and dar
          • 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 CalDAV
            • Troubleshooting
          • Developer Test Environment
            • Installing Cassandane
            • Rebuild Cyrus for Testing
            • Running the tests
            • Debugging and stacktraces
            • Tips and Tricks
          • Test Coverage
            • One-time setup
            • Preparing a coverage report
          • JMAP support
            • Cyrus administration
            • JMAP client
        • Cyrus internals and libraries
          • Namespaces: a developer view
          • Developer Libraries
            • List of Libraries
        • Releasing
          • Releasing Cyrus IMAP - normal releases
            • Prerequisites
            • Release notes
            • Pre-release testing
            • Linking up release notes
            • Version tagging
            • Inter-version website consistency
            • Uploading
            • Tell the world
          • Releasing Cyrus IMAP - major releases
            • Prerequisites
            • Feature freeze
            • Make sure master is good
            • Forking the new series branch
            • Updating the master branch
            • Github updates
            • Revert anything that's not yet ready
            • Tell the website builder about the new branch
            • First beta
            • Subsequent betas
            • Release candidates
            • Release
            • Post-release
          • Releasing Cyrus IMAP - developer snapshots
            • Prerequisites
            • Make sure master is good
            • Mixed-version Cassandane testing
            • lib/imapoptions
            • Release notes
            • docsrc/conf.py
            • check documentation
            • PR and/or commit
            • Tag
            • Tell the world
            • Update this document
      • Using the Cassandane test suite
        • Table of Contents
        • 1. Introduction
        • 2. What Is A Unit Test?
        • 3. Running The Tests
        • 3.1. Setting Up The Machine
        • 3.2 Configure Script
        • 3.3 Make
        • 3.4 Using Valgrind
        • 3.5 The Tests Are Failing
          • 3.6 Debugging A Test
        • 4. Adding Your Own Tests
        • 4.1 Where To Put Your Tests
        • 4.2 Adding A New Suite
        • 4.3 Adding A Test To A Suite
        • 4.4 Suite Setup And Teardown
    • Cyrus Internals
      • Cyrus APIs
        • CyrusDB API
          • The interface
            • cyrusdb.h
            • cyrusdb.c
            • cyrusdb_*.c
          • Configuration
          • A full example
          • Tools
            • imap/ctl_cyrusdb
            • imap/cvt_cyrusdb
            • imap/cyr_dbtool
          • How to use CyrusDB
          • Reading, Writing, & Transactions
            • Reading
            • About Transactions
            • Writing
          • Gotchas!
          • API Reference
            • cyrusdb_init(void)
            • cyrusdb_done(void)
            • cyrusdb_sync(const char *backend)
            • cyrusdb_open(const char *backend, const char *fname, int flags, struct db **retdb)
            • cyrusdb_close(struct db *db)
            • cyrusdb_fetch(struct db *db, const char *key, size_t keylen, const char **data, size_t *datalen, struct txn **tidptr)
            • cyrusdb_fetchlock(struct db *db, const char *key, size_t keylen, const char **data, size_t *datalen, struct txn **tidptr)
            • cyrusdb_foreach(struct db *db, const char *prefix, size_t prefixlen, foreach_p *goodp, foreach_p *procp, void *rock, struct txn **tidptr)
            • cyrusdb_forone(struct db *db, const char *key, size_t keylen, foreach_p *goodp, foreach_p *procp, void *rock, struct txn **tidptr)
            • cyrusdb_create(struct db *db, const char *key, size_t keylen, const char *data, size_t datalen, struct txn **tidptr)
            • cyrusdb_store(struct db *db, const char *key, size_t keylen, const char *data, size_t datalen, struct txn **tidptr)
            • cyrusdb_delete(struct db *db, const char *key, size_t keylen, struct txn **tidptr, int force)
            • cyrusdb_commit(struct db *db, struct txn *tid)
            • cyrusdb_abort(struct db *db, struct txn *tid)
            • cyrusdb_dump(struct db *db, int detail)
            • cyrusdb_consistent(struct db *db)
        • cyrusdb API
          • Intro
          • Code Layout
          • Configuration
          • A full example
          • About Transactions
          • API Reference
            • cyrusdb_init(void)
            • cyrusdb_done(void)
            • cyrusdb_sync(const char *backend)
            • cyrusdb_open(const char *backend, const char *fname, int flags, struct db **retdb)
            • cyrusdb_close(struct db *db)
            • cyrusdb_fetch(struct db *db, const char *key, size_t keylen, const char **data, size_t *datalen, struct txn **tidptr)
            • cyrusdb_fetchlock(struct db *db, const char *key, size_t keylen, const char **data, size_t *datalen, struct txn **tidptr)
            • cyrusdb_foreach(struct db *db, const char *prefix, size_t prefixlen, foreach_p *goodp, foreach_p *procp, void *rock, struct txn **tidptr)
            • cyrusdb_forone(struct db *db, const char *key, size_t keylen, foreach_p *goodp, foreach_p *procp, void *rock, struct txn **tidptr)
            • cyrusdb_create(struct db *db, const char *key, size_t keylen, const char *data, size_t datalen, struct txn **tidptr)
            • cyrusdb_store(struct db *db, const char *key, size_t keylen, const char *data, size_t datalen, struct txn **tidptr)
            • cyrusdb_delete(struct db *db, const char *key, size_t keylen, struct txn **tidptr, int force)
            • cyrusdb_commit(struct db *db, struct txn *tid)
            • cyrusdb_abort(struct db *db, struct txn *tid)
            • cyrusdb_dump(struct db *db, int detail)
            • cyrusdb_consistent(struct db *db)
        • Index API
          • Intro
          • Opening and closing
          • The Index Model
        • Mailbox API
          • Intro
          • Opening and closing
          • Locking and unlocking
          • Creating, renaming and deleting
          • Reading and writing records
            • Appending
            • Committing
            • Cache records
          • Delayed Actions
            • first, unlock
            • then: close
      • Thoughts & Notes
        • Cyrus IMAP Server: Sieve Bytecode
          • Motivation
          • Overall Bytecode Format
          • Generation
          • Evaluation
          • Other things to consider
        • Cyrus CalDAV Scheduling Flowchart
          • caldav_put() - create/modify via HTTP PUT on a resource or POST (add-member) on a calendar
          • caldav_delete_sched() - remove via HTTP DELETE on a resource
          • caldav_post() - busytime query via HTTP POST on Scheduling Outbox
          • sched_pollstatus - perform a voter response update
          • sched_request() - perform an organizer request / attendee status update
          • process_attendees() - create a suitable iTIP request message for each attendee
          • sched_exclude() - exclude an attendee from a recurrence instance
          • sched_cancel() - cancel an organizer event/task
          • sched_reply() - perform an attendee reply
          • trim_attendees() - remove all attendees other than the one replying
          • sched_vpoll_reply() - add voter responses to VPOLL reply
          • sched_decline() - decline a recurrence instance for an attendee
          • clean_component() - sanitize a component for use in an iTIP message
          • sched_deliver() - deliver an iTIP message to a recipient
          • sched_deliver_local() - deliver an iTIP message to a local user
          • deliver_merge_reply() - update an organizer resource with an attendee reply
          • deliver_merge_vpoll_reply() - update an organizer resource with voter responses
          • deliver_merge_request() - create/update an attendee resource with an organizer request
          • deliver_merge_pollstatus() - update voter responses on a voter resource
          • sched_deliver_remote() - deliver an iTIP message to a remote user
          • isched_send() - deliver an iTIP message to a remote user via iSchedule (HTTP)
          • imip_send() - deliver an iTIP message to a remote user via iMIP (SMTP)
          • sched_busytime_query() - perform a busytime query
          • busytime_query_local() - perform a busytime query on a local user
          • busytime_query_remote() - perform a busytime query on a remote user
        • Cyrus IMAP Server: Notes
        • Cyrus IMAP Server: Prot Events
      • Guidance for Developers
        • Cyrus IMAP Server: Hacking
          • Memory Allocation
          • strlcpy vs strncpy vs memcpy
          • map_refresh and map_free
          • Network Functions
          • (todo) Authorization Modules
          • General Hints
          • Coding Standards
        • Cyrus IMAP Server: Internationalization
          • introduction
          • cyrus canonical form
          • external interface
          • the TRANSLATE macro: using the transcoding tables
            • control codes
            • control code reference
          • searching and compiled patterns
            • boyer-moore
            • cyrus implementation
          • generating the tables: mkchartable
            • charset tables
            • unicode data table
            • unicode fixup table
            • generating chartable.c
          • for the future
            • Sieve/ACAP comparators
            • adjustable normalization?
            • handle >2 octet input characters
            • make UTF-8 more regular
            • require minimal UTF-8 characters
          • references
        • Cyrus IMAP Server: Locking
          • Mailboxes
          • Xapian
            • Locking orders
          • Lock lifetime
        • Cyrus IMAP Server: Mailbox File Formats
          • Intro
          • Message Files
          • cyrus.header
            • Locking Considerations
          • cyrus.cache
            • Locking Considerations
          • cyrus.index
            • Locking Considerations
            • Detail of cyrus.index header
            • Detail of cyrus.index records
          • Notes
          • Future considerations
        • Cyrus IMAP Server: Namelocks
          • Intro
          • Implementation
          • API
            • Example:
            • Re-locking considerations
        • Cyrus IMAP Server: prot layer
          • Events
        • Cyrus IMAP Server: Replication Examples
          • Introduction
          • A short example of replication in action
          • Tracking messages between folders
        • Cyrus IMAP Server: Replication Protocol v2.4+
          • DList 1.0
            • types
        • Cyrus IMAP Server: Special Characters
          • Current Uses
          • Future Uses
        • Cyrus IMAP Server: var directory structure
          • Directory structure under /var/spool/imap
          • Directory structure under /var/imap
  • Support/Community
    • Found a bug?
    • Mailing lists
    • Weekly meetings
    • About
      • What is Cyrus
        • What is Cyrus
        • What is IMAP?
        • IMAP Version 4 (IMAP4)
        • Mime
        • SMTP
      • Who Is Cyrus
        • Core Contributors
        • Individual contributors and past contributors
      • Cyrus Roadmap
        • High Level Roadmap
          • Future
      • Cyrus History
      • Cyrus Bylaws
        • I. The Cyrus Governance Board
        • II. The Cyrus Core Developers Group
        • III. The Release Engineer
        • IV. Development Process
        • V. Changes to the Bylaws