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
            • Cyrus IMAP 3.13.1 Tag Notes
            • Cyrus IMAP 3.13.2 Tag Notes
            • Cyrus IMAP 3.13.3 Tag Notes
            • Cyrus IMAP 3.13.4 Tag Notes
            • Cyrus IMAP 3.13.5 Tag Notes
            • Cyrus IMAP 3.13.6 Tag Notes
            • Cyrus IMAP 3.13.7 Tag Notes
            • Cyrus IMAP 3.13.8 Tag Notes
      • Supported Versions
        • 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.12.0 Release Notes
            • Cyrus IMAP 3.12.1 Release Notes
            • Cyrus IMAP 3.12.2 Release Notes
            • Cyrus IMAP 3.12.3 Release Notes
            • Cyrus IMAP 3.12.4 Release Notes
          • Cyrus IMAP 3.11 Snapshots
            • Cyrus IMAP 3.11.0-alpha0 Tag Notes
      • Older Versions
        • Series 3.x
          • 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.10.2 Release Notes
            • Cyrus IMAP 3.10.3 Release Notes
            • Cyrus IMAP 3.10.4 Release Notes
          • Cyrus IMAP 3.9 Snapshots
            • Cyrus IMAP 3.9.0-alpha0 Tag Notes
          • 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.8.6 Release Notes
            • Cyrus IMAP 3.8.7 Release Notes
            • Cyrus IMAP 3.8.8 Release Notes
          • Cyrus IMAP 3.7 Snapshots
            • Cyrus IMAP 3.7.0-alpha0 Tag Notes
          • 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
    • Compiling
      • Setting up dependencies
        • Required Build Dependencies
        • Build dependencies for additional functionality
          • SASL Authentication
          • Alternate database formats
          • CalDAV, CardDAV, or JMAP (httpd subsystem)
          • Other
      • Compile Cyrus
        • Default build: mail only
        • Optional dependencies
          • JMAP
          • Murder
          • Replication
        • Compile
        • Check
    • Installing Cyrus
      • Install Cyrus
      • Additional Configuration
        • HTTP modules
          • About http module support
          • HTTPD Configuration
            • General configuration
            • Authentication
          • Module-specific information
            • CalDAV
            • CardDAV
            • WebDAV
            • JMAP
            • Media Conversion
          • For end users
        • Virus Scanner
          • About virus scan support
          • Virus Scanner Configuration
            • General configuration
            • ClamAV
        • Configuring the MTA
      • 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
      • Configuring Xapian
      • Launch Cyrus
      • Send a test email
      • Checking CardDAV and CalDAV
      • Troubleshooting
    • Upgrading to 3.13
      • 1. Preparation
        • Versions to upgrade from
        • Configuration changes
          • Eliminate overlapping partitions
        • JMAP/CalDAV changes
          • New JMAP Email/query filter conditions
        • PCRE2 support
        • Objectstore removal
        • Configuration updates
        • Time zone data
        • Replication
        • Search indexes
        • Client-visible changes
        • 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
  • Quickstart Guide
    • 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
    • Introduction to Cyrus IMAP
      • What is IMAP?
    • 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
    • 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
    • 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"
      • 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
    • RFCs Supported by Cyrus IMAP
      • IETF RFC Drafts
      • RFC Wishlist
    • Protocol Extensions
      • CalDAV and CardDAV Extensions
        • XML Namespaces
        • Properties
          • CY:schedule-user-address
          • CY:scheduling-enabled
          • CY:address-groups
        • Privileges
          • Under DAV:write-properties
          • Under DAV:bind
          • Under DAV:unbind
      • /dblookup HTTP API
        • Authentication
        • Common Request Format
        • Response Codes
        • Endpoints
          • GET /dblookup/email
          • GET /dblookup/email2uids
          • GET /dblookup/email2details
          • GET /dblookup/uid2groups
          • GET /dblookup/expandcard
          • GET /dblookup/mbpath
      • JMAP for Contacts extensions
        • Changes to AddressBook
          • New Properties
        • Changes to ContactCard
          • New Properties
        • New Method: ContactCard/parse
      • LMTP extensions
        • IGNOREQUOTA
        • TRACE
        • SESSIONID in responses
      • Memo threading
        • X-ME-Memo-For
        • Fallbacks
      • Sieve extensions
        • snooze
        • regex
        • vnd.cyrus.jmapquery
        • vnd.cyrus.implicit_keep_target
        • vnd.cyrus.log
  • Setup
  • Operations
    • Man pages
      • (5) Configuration Files
        • cyrus.conf
          • Description
          • Section Descriptions
            • START
            • SERVICES
            • EVENTS
            • DAEMON
          • Examples
          • Access Control
          • See Also
        • imapd.conf
          • DESCRIPTION
          • OPTION DESCRIPTIONS
            • @include
            • acl_admin_implies_write
            • addressbookprefix
            • admins
            • admins_get_internal_seen
            • afspts_localrealms
            • afspts_mycell
            • allowallsubscribe
            • allowanonymouslogin
            • allowapop
            • allowdeleted
            • allownewnews
            • allowplaintext
            • allowsetacl
            • allowspecialusesubfolder
            • allowstarttls
            • allowusermoves
            • altnamespace
            • altprefix
            • annotation_allow_undefined
            • annotation_callout
            • annotation_callout_disable_append
            • annotation_db
            • annotation_db_path
            • annotation_definitions
            • annotation_enable_legacy_commands
            • anyoneuseracl
            • anysievefolder
            • aps_expiry
            • aps_topic
            • aps_topic_caldav
            • aps_topic_carddav
            • archive_after
            • archive_days
            • archive_enabled
            • archive_keepflagged
            • archive_maxsize
            • archivepartition-name
            • auditlog
            • auth_mech
            • autocreate_acl
            • autocreate_inbox_folders
            • autocreate_post
            • autocreate_quota
            • autocreate_quota_messages
            • autocreate_sieve_compiled_script
            • autocreate_sieve_folders
            • autocreate_sieve_script
            • autocreate_sieve_script_compile
            • autocreate_sieve_script_compiled
            • autocreate_subscribe_folders
            • autocreate_subscribe_sharedfolders
            • autocreate_subscribe_sharedfolders_all
            • autocreate_users
            • autocreateinboxfolders
            • autocreatequota
            • autocreatequotamsg
            • autoexpunge
            • autosievefolders
            • autosubscribe_all_sharedfolders
            • autosubscribeinboxfolders
            • autosubscribesharedfolders
            • backup_compact_maxsize
            • backup_compact_minsize
            • backup_compact_work_threshold
            • backup_db
            • backup_db_path
            • backup_keep_previous
            • backup_retention
            • backup_retention_days
            • backup_staging_path
            • backuppartition-name
            • boundary_limit
            • caldav_accept_invalid_rrules
            • caldav_alarm_db_path
            • caldav_alarm_support_components
            • caldav_alarm_suppress_file
            • caldav_allowattach
            • caldav_allowcalendaradmin
            • caldav_allowscheduling
            • caldav_create_attach
            • caldav_create_default
            • caldav_create_sched
            • caldav_historical_age
            • caldav_maxdatetime
            • caldav_mindatetime
            • caldav_realm
            • calendar_component_set
            • calendar_default_displayname
            • calendar_max_expanded_instances
            • calendar_minimum_alarm_interval
            • calendar_suppress_duplicate_alarms
            • calendar_user_address_set
            • calendarprefix
            • carddav_allowaddmember
            • carddav_allowaddressbookadmin
            • carddav_realm
            • carddav_repair_vcard
            • caringo_hostname
            • caringo_port
            • chatty
            • client_bind
            • client_bind_name
            • client_timeout
            • commandmintimer
            • configdirectory
            • conversations
            • conversations_counted_flags
            • conversations_db
            • conversations_expire_after
            • conversations_expire_days
            • conversations_keep_existing
            • conversations_max_guidexists
            • conversations_max_guidinfolder
            • conversations_max_guidrecords
            • conversations_max_thread
            • createonpost
            • crossdomains
            • crossdomains_onlyother
            • cyrus_group
            • cyrus_user
            • cyrusdb_autoconvert
            • dav_lock_timeout
            • dav_realm
            • davdriveprefix
            • davnotificationsprefix
            • debug
            • debug_command
            • debug_log_sync_partition_choice
            • debug_slowio
            • debug_writefail_guid
            • defaultacl
            • defaultdomain
            • defaultpartition
            • defaultsearchtier
            • defaultserver
            • delete_mode
            • delete_unsubscribe
            • deletedprefix
            • deleteright
            • disable_shared_namespace
            • disable_user_namespace
            • disconnect_on_vanished_mailbox
            • dkim2_message_instance
            • duplicate_db
            • duplicate_db_path
            • duplicatesuppression
            • event_content_inclusion_mode
            • event_content_size
            • event_exclude_flags
            • event_exclude_specialuse
            • event_extra_params
            • event_groups
            • event_notifier
            • expire_by_savedate
            • expire_keep_flagged
            • expunge_mode
            • failedloginpause
            • fastmailsharing
            • fatals_abort
            • flushseenstate
            • foolstupidclients
            • force_sasl_client_mech
            • fulldirhash
            • generate_compiled_sieve_script
            • global_lock
            • hashimapspool
            • hostname_mechs
            • hostname_password
            • http_allow_0rtt
            • http_h2_altsvc
            • http_jwt_key_dir
            • http_jwt_max_age
            • httpallowcompress
            • httpallowcors
            • httpallowedurls
            • httpallowtrace
            • httpcontentmd5
            • httpdocroot
            • httpkeepalive
            • httplogheaders
            • httpmodules
            • httpprettytelemetry
            • httppts_uri
            • httptimeout
            • icalendar_max_size
            • idlesocket
            • ignorereference
            • imap_inprogress_interval
            • imapidlepoll
            • imapidletimeout
            • imapidresponse
            • imapmagicplus
            • imipnotifier
            • implicit_owner_rights
            • improved_mboxlist_sort
            • iolog
            • ischedule_dkim_domain
            • ischedule_dkim_key_file
            • ischedule_dkim_required
            • ischedule_dkim_selector
            • jmap_emailsearch_db_path
            • jmap_imagesize_annot
            • jmap_inlinedcids_annot
            • jmap_mail_max_size_attachments_per_email
            • jmap_max_calendareventnotifs
            • jmap_max_calls_in_request
            • jmap_max_catenate_items
            • jmap_max_concurrent_requests
            • jmap_max_concurrent_upload
            • jmap_max_delayed_send
            • jmap_max_objects_in_get
            • jmap_max_objects_in_set
            • jmap_max_size_blob_set
            • jmap_max_size_request
            • jmap_max_size_upload
            • jmap_nonstandard_extensions
            • jmap_preview_annot
            • jmap_preview_length
            • jmap_pushpoll
            • jmap_querycache_max_age
            • jmap_require_accountid
            • jmap_set_has_attachment
            • jmap_vacation
            • jmapaccess_url
            • jmapnotificationfolder
            • jmappushsubscriptionfolder
            • jmapsubmission_deleteonsend
            • jmapsubmissionfolder
            • jmapuploadfolder
            • ldap_authz
            • ldap_base
            • ldap_bind_dn
            • ldap_ca_dir
            • ldap_ca_file
            • ldap_ciphers
            • ldap_client_cert
            • ldap_client_key
            • ldap_deref
            • ldap_domain_base_dn
            • ldap_domain_filter
            • ldap_domain_name_attribute
            • ldap_domain_result_attribute
            • ldap_domain_scope
            • ldap_filter
            • ldap_group_base
            • ldap_group_filter
            • ldap_group_scope
            • ldap_groupmember_attribute
            • ldap_id
            • ldap_mech
            • ldap_member_attribute
            • ldap_member_base
            • ldap_member_filter
            • ldap_member_method
            • ldap_member_scope
            • ldap_password
            • ldap_realm
            • ldap_referrals
            • ldap_restart
            • ldap_sasl
            • ldap_sasl_authc
            • ldap_sasl_authz
            • ldap_sasl_mech
            • ldap_sasl_password
            • ldap_sasl_realm
            • ldap_scope
            • ldap_servers
            • ldap_size_limit
            • ldap_start_tls
            • ldap_time_limit
            • ldap_timeout
            • ldap_tls_cacert_dir
            • ldap_tls_cacert_file
            • ldap_tls_cert
            • ldap_tls_check_peer
            • ldap_tls_ciphers
            • ldap_tls_key
            • ldap_uri
            • ldap_user_attribute
            • ldap_verify_peer
            • ldap_version
            • literalminus
            • lmtp_catchall_mailbox
            • lmtp_downcase_rcpt
            • lmtp_exclude_specialuse
            • lmtp_fuzzy_mailbox_match
            • lmtp_over_quota_perm_failure
            • lmtp_preparse
            • lmtp_strict_quota
            • lmtp_strict_rfc2821
            • lmtpsocket
            • lmtptxn_timeout
            • lock_debugtime
            • loginrealms
            • loginuseacl
            • logtimestamps
            • mailbox_default_options
            • mailbox_initial_flags
            • mailbox_legacy_dirs
            • mailbox_maxmessages_addressbook
            • mailbox_maxmessages_calendar
            • mailbox_maxmessages_email
            • mailnotifier
            • master_bind_errors_fatal
            • master_pid_file
            • master_ready_file
            • maxargssize
            • maxheaderlines
            • maxliteral
            • maxlogins_per_host
            • maxlogins_per_user
            • maxmessagesize
            • maxquoted
            • maxword
            • mboxkey_db
            • mboxlist_db
            • mboxlist_db_path
            • mboxname_lockpath
            • mboxname_userpath
            • metapartition-name
            • metapartition_files
            • munge8bit
            • mupdate_authname
            • mupdate_config
            • mupdate_connections_max
            • mupdate_password
            • mupdate_port
            • mupdate_realm
            • mupdate_retry_delay
            • mupdate_server
            • mupdate_username
            • mupdate_workers_max
            • mupdate_workers_maxspare
            • mupdate_workers_minspare
            • mupdate_workers_start
            • netscapeurl
            • newsaddheaders
            • newsgroups
            • newsmaster
            • newspeer
            • newspostuser
            • newsprefix
            • newsrc_db_path
            • nntptimeout
            • notesmailbox
            • notify_external
            • notifysocket
            • object_storage_dummy_spool
            • object_storage_enabled
            • openio_account
            • openio_autocreate
            • openio_namespace
            • openio_proxy_timeout
            • openio_rawx_timeout
            • openio_verbosity
            • partition-name
            • partition_select_exclude
            • partition_select_mode
            • partition_select_soft_usage_limit
            • partition_select_usage_reinit
            • plaintextloginalert
            • plaintextloginpause
            • popexpiretime
            • popminpoll
            • poppollpadding
            • popsubfolders
            • poptimeout
            • popuseacl
            • popuseimapflags
            • postmaster
            • postspec
            • postuser
            • proc_path
            • prometheus_enabled
            • prometheus_master_update_freq
            • prometheus_need_auth
            • prometheus_service_update_freq
            • prometheus_stats_dir
            • prometheus_update_freq
            • prometheus_usage_update_freq
            • proxy_authname
            • proxy_compress
            • proxy_password
            • proxy_realm
            • proxyd_allow_status_referral
            • proxyd_disable_mailbox_referrals
            • proxyservers
            • ptloader_sock
            • pts_module
            • ptscache_db
            • ptscache_db_path
            • ptscache_timeout
            • ptskrb5_convert524
            • ptskrb5_strip_default_realm
            • qosmarking
            • quota_db
            • quota_db_path
            • quota_use_conversations
            • quotawarn
            • quotawarnkb
            • quotawarnmsg
            • quotawarnpercent
            • quotawarnsize
            • readonly
            • reject8bit
            • replicaonly
            • restore_authname
            • restore_password
            • restore_realm
            • reverseacls
            • reverseuniqueids
            • rfc2046_strict
            • rfc2047_utf8
            • rfc3028_strict
            • rss_feedlist_template
            • rss_feeds
            • rss_maxage
            • rss_maxitems
            • rss_maxsynopsis
            • rss_realm
            • sasl_auto_transition
            • sasl_maximum_layer
            • sasl_minimum_layer
            • sasl_option
            • sasl_pwcheck_method
            • search_attachment_extractor_idle_timeout
            • search_attachment_extractor_request_timeout
            • search_attachment_extractor_url
            • search_batchsize
            • search_engine
            • search_fuzzy_always
            • search_index_headers
            • search_index_language
            • search_index_parts
            • search_index_skip_domains
            • search_index_skip_users
            • search_indexed_db
            • search_maxsize
            • search_maxtime
            • search_normalisation_max
            • search_query_language
            • search_queryscan
            • search_skipdiacrit
            • search_skiphtml
            • search_snippet_length
            • search_stopword_path
            • search_whitespace
            • searchpartition-name
            • seenstate_db
            • sendmail
            • sendmail_auth_id
            • serverinfo
            • serverlist
            • serverlist_select_mode
            • serverlist_select_soft_usage_limit
            • serverlist_select_usage_reinit
            • servername
            • sharedprefix
            • sieve_allowreferrals
            • sieve_duplicate_max_expiration
            • sieve_extensions
            • sieve_folder
            • sieve_maxscripts
            • sieve_maxscriptsize
            • sieve_mdn_original_recipient_header
            • sieve_mdn_private
            • sieve_sasl_send_unsolicited_capability
            • sieve_use_lmtp_reject
            • sieve_utf8fileinto
            • sieve_vacation_max_response
            • sieve_vacation_min_response
            • sievedir
            • sievenotifier
            • sieveusehomedir
            • singleinstancestore
            • skiplist_always_checkpoint
            • skiplist_unsafe
            • smtp_auth_authname
            • smtp_auth_password
            • smtp_auth_realm
            • smtp_backend
            • smtp_host
            • soft_noauth
            • sortcache_db
            • specialuse_extra
            • specialuse_nochildren
            • specialuse_protect
            • specialusealways
            • sql_database
            • sql_engine
            • sql_hostnames
            • sql_passwd
            • sql_user
            • sql_usessl
            • squatter_batch_delay
            • srs_alwaysrewrite
            • srs_domain
            • srs_hashlength
            • srs_secrets
            • srs_separator
            • srvtab
            • statuscache
            • statuscache_db
            • statuscache_db_path
            • submitservers
            • subscription_db
            • suppress_capabilities
            • sync_authname
            • sync_batchsize
            • sync_cache_db
            • sync_cache_db_path
            • sync_host
            • sync_log
            • sync_log_chain
            • sync_log_channels
            • sync_log_unsuppressable_channels
            • sync_password
            • sync_port
            • sync_realm
            • sync_reconnect_maxwait
            • sync_repeat_interval
            • sync_rightnow_channel
            • sync_shutdown_file
            • sync_timeout
            • sync_try_imap
            • syslog_facility
            • syslog_prefix
            • tcp_keepalive
            • tcp_keepalive_cnt
            • tcp_keepalive_idle
            • tcp_keepalive_intvl
            • telemetry_bysessionid
            • temp_path
            • timeout
            • tls_ca_file
            • tls_ca_path
            • tls_cert_file
            • tls_cipher_list
            • tls_ciphers
            • tls_client_ca_dir
            • tls_client_ca_file
            • tls_client_cert
            • tls_client_certs
            • tls_client_key
            • tls_crl_file
            • tls_eccurve
            • tls_key_file
            • tls_prefer_server_ciphers
            • tls_required
            • tls_server_ca_dir
            • tls_server_ca_file
            • tls_server_cert
            • tls_server_dhparam
            • tls_server_key
            • tls_session_timeout
            • tls_sessions_db
            • tls_sessions_db_path
            • tls_versions
            • tlscache_db
            • tlscache_db_path
            • uidbatches_max_messages
            • uidbatches_min_batch
            • uidl_format
            • umask
            • unix_group_enable
            • unixhierarchysep
            • userdeny_db
            • userdeny_db_path
            • username_tolower
            • userprefix
            • vcard_max_size
            • virtdomains
            • virusscan_notification_subject
            • virusscan_notification_template
            • webdav_attachments_baseurl
            • webdav_attachments_max_binary_attach_size
            • websocket_timeout
            • xbackup_enabled
            • xlist-flag
            • zeroskip_index_path
            • zoneinfo_db
            • zoneinfo_db_path
            • zoneinfo_dir
          • SEE ALSO
      • (8) System Commands
        • arbitron
          • Synopsis
          • Description
          • Options
          • Examples
          • Files
          • See Also
        • backupcyrusd
          • Synopsis
          • Description
          • Options
          • 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_guesstz
          • Synopsis
          • Description
          • Options
          • Examples
          • 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
        • cyrdump
          • Synopsis
          • Description
          • Options
        • deliver
          • Synopsis
          • Description
          • Options
          • NOTES
          • Examples
          • Files
          • 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
        • mupdate
          • Synopsis
          • Description
          • Options
          • Examples
          • 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
        • 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
        • dav_reconstruct
          • Synopsis
          • Description
          • Options
        • httptest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • imtest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • lmtptest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • mupdatetest
          • Synopsis
          • Description
          • Options
          • Examples
          • See Also
        • 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 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
        • Help! There must be an easier way to get all this going...
      • 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
    • Getting Started
      • Development process
        • Before you begin
        • From a PR to a merge
          • Content linters
          • Describing your change for the release notes
          • Commit messages
        • The release cycle
      • How to hack on Cyrus
        • Prerequisites
        • Building and testing
        • Writing tests
          • Conventions
      • Overview of Cyrus development environment
        • cyrus-docker, cyd, and dar
          • cyd
          • dar
      • The source tree
        • The code that ships
          • The libraries
        • Tests
        • Documentation and release engineering
        • Build and tooling
    • Contributing
      • C style
        • clang-format is the arbiter
        • Conventions clang-format can't express
        • Process conventions
      • Structured logging
        • Why a rulebook
        • The shape of an event
        • Emitting an event
          • 1. xsyslog_ev() — for a one-off event
          • 2. A typed event module — for an event logged from several places
          • 3. struct logfmt directly — for events built up conditionally
        • Naming events
        • Naming keys
        • Values
          • Absent values
          • Lists
          • Things not to log
        • Choosing a severity
        • Adding to the vocabulary
        • Changing an existing event
        • Converting an existing call site
        • Where the code lives
      • Contributing to the documentation
        • Overview
          • Source formats
          • Generated pages
        • Special Tags
          • rfc
          • cyrusman
          • imap_current_stable_version
        • Conventions: Man Pages
          • Synopsis
          • Examples
      • The CUnit (C) test suite
        • 1. Introduction
        • 2. Running the tests
          • 2.1 Make
          • 2.2 Using Valgrind
          • 2.3 The tests are failing
          • 2.4 Debugging a test
        • 3. Adding your own tests
          • 3.1 Where to put your tests
          • 3.2 Adding a new suite
          • 3.3 Adding a test to a suite
          • 3.4 Suite setup and teardown
      • The Cassandane (Perl) test suite
        • 1.1 Introduction
        • 1.2 Running the tests
        • 1.3 Writing a test
          • 1.3.1 One test, many variants
          • 1.3.2 Assertions
            • 1.3.2.1 Comparing iCalendar and vCard data
        • 1.4 Test attributes
        • 1.5 The object model
        • 1.6 Module reference
    • Cyrus Internals
      • Cyrus APIs
        • Audit Log API
        • 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
      • Annotator protocol
        • Introduction
          • When is the callout invoked?
          • Terminology
        • Transport protocol
        • Annotator request
          • FILENAME
          • ANNOTATIONS
          • FLAGS
          • BODY
          • GUID
        • Annotator reply
        • Worked Example
      • Replication protocol
        • Introduction
          • Terminology
        • The Sync Algorithm
          • User-Level Sync Flow
          • Reserve-Then-Upload Flow
          • Sync CRCs
            • Incremental Maintenance
            • SYNC_CRC (basic)
            • SYNC_CRC_ANNOT
            • Forced Recalculation
            • Change Detection and Convergence
          • The sync_cache
            • Round-Trip Analysis
          • SINCE_MODSEQ and Incremental Sync
          • Partial Sync for Large Mailboxes
          • Retry Logic
          • Conflict Resolution
            • GUID Conflicts and UID Renumbering
            • Mailbox-Level Conflict Resolution
          • Lock Ordering
        • Rolling Replication
          • The sync_log
          • sync_log File Structure
          • The Log/Log-Run Lock Dance
          • Other sync_log Consumers
          • Channel Independence
          • Action Coalescing
          • Processing Order
          • Error Promotion
          • Locked Mailbox Handling
          • Daemon Loop
          • One-Shot vs. Rolling
        • The DList Wire Format
          • Types
            • atom
            • flag
            • num32/num
            • hex32/hex
            • map
            • list
            • kvlist
            • file
        • Session Lifecycle
          • Server Banner
          • AUTHENTICATE
          • STARTTLS
          • COMPRESS
          • NOOP
          • RESTART
          • EXIT
        • Command/Response Framing
          • Tagged Commands (Standalone sync_server)
          • Untagged Data
          • Tagged Responses
          • Error Codes
          • IMAP-Embedded Mode
        • The Replication Protocol
          • GET Commands
            • GET USER
            • GET MAILBOXES mboxname-list
            • GET UNIQUEIDS uniqueid-list
            • GET FULLMAILBOX mboxname
            • GET QUOTA quotaroot
            • GET SIEVE userid
            • GET META userid
            • GET FETCH mboxname uid
            • GET FETCH_SIEVE userid scriptname
            • GET ANNOTATION
          • APPLY Commands
            • APPLY RESERVE
            • APPLY MESSAGE
            • APPLY MAILBOX
            • APPLY LOCAL_MAILBOX
            • APPLY UNMAILBOX
            • APPLY LOCAL_UNMAILBOX
            • APPLY RENAME
            • APPLY LOCAL_RENAME
            • APPLY EXPUNGE
            • APPLY QUOTA
            • APPLY UNQUOTA
            • APPLY SUB
            • APPLY UNSUB
            • APPLY ANNOTATION
            • APPLY UNANNOTATION
            • APPLY SIEVE
            • APPLY UNSIEVE
            • APPLY ACTIVATE_SIEVE
            • APPLY UNACTIVATE_SIEVE
            • APPLY SEEN
            • APPLY UNUSER
            • APPLY LOCAL_UNUSER
            • APPLY FORCE
            • APPLY CAPABILITIES
        • Debugging with Telemetry
      • 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: 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
        • Namespaces: a developer view
        • Cyrus IMAP Server: Notes
        • Cyrus IMAP Server: prot layer
          • Events
        • Cyrus IMAP Server: Prot Events
        • 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
    • Releasing
      • Releasing a version of Cyrus
        • Releasing a new developer snapshot of Cyrus
          • 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
        • Releasing a new major version of Cyrus
          • 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 a new minor version of Cyrus
          • Prerequisites
          • Release notes
          • Pre-release testing
          • Linking up release notes
          • Version tagging
          • Inter-version website consistency
          • Uploading
          • Tell the world
  • Support/Community
    • Found a bug?
    • How we classify security issues
      • The three outcomes
      • What we embargo
        • Veto 1: Self-contained
        • Veto 2: Reasonable configuration
        • Veto 3: Non-experimental
        • Final test: Lasting harm
      • What we do not embargo
      • Applying these rules
      • What this policy does not promise
    • Mailing lists
    • 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
  • Glossary