Package cyrus-imapd

A high-performance mail server with IMAP, POP3, NNTP and SIEVE support

http://www.cyrusimap.org/

The cyrus-imapd package contains the core of the Cyrus IMAP server.
It is a scaleable enterprise mail system designed for use from
small to large enterprise environments using standards-based
internet mail technologies.

A full Cyrus IMAP implementation allows a seamless mail and bulletin
board environment to be set up across multiple servers. It differs from
other IMAP server implementations in that it is run on "sealed"
servers, where users are not normally permitted to log in and have no
system account on the server. The mailbox database is stored in parts
of the file system that are private to the Cyrus IMAP server. All user
access to mail is through software using the IMAP, POP3 or KPOP
protocols. It also includes support for virtual domains, NNTP,
mailbox annotations, and much more. The private mailbox database design
gives the server large advantages in efficiency, scalability and
administratability. Multiple concurrent read/write connections to the
same mailbox are permitted. The server supports access control lists on
mailboxes and storage quotas on mailbox hierarchies.

The Cyrus IMAP server supports the IMAP4rev1 protocol described
in RFC 3501. IMAP4rev1 has been approved as a proposed standard.
It supports any authentication mechanism available from the SASL
library, imaps/pop3s/nntps (IMAP/POP3/NNTP encrypted using SSL and
TLSv1) can be used for security. The server supports single instance
store where possible when an email message is addressed to multiple
recipients, SIEVE provides server side email filtering.

File Formats (Section 5)
cyrus.conf
/etc/cyrus.conf is the configuration file for the Cyrus master process. It defines the startup procedures, services and events to be spawned by master. The...
imapd.conf
/etc/imapd.conf is the configuration file for the Cyrus IMAP server. It defines local parameters for IMAP. Each line of the /etc/imapd.conf file has the...
krb.equiv
krb.equiv contains zero or more lines, each of which describes a mapping of a kerberos principal (userid@host) to a local user (userid or alias). Each line of...
System Administration (Section 8)
arbitron
Arbitron collects and reports readership statistics for mailboxes on the server. It also optionally prunes the mailboxes of \Seen state for dormant users...
chk_cyrus
Chk_cyrus is used to perform a consistency check on the cyrus datastore, and output a list of files/directories that are expected to exist, but do not. Status...
ctl_cyrusdb
Ctl_cyrusdb is used to perform various administrative operations on the Cyrus databases. Ctl_cyrusdb reads its configuration options out of the imapd.conf(5)...
ctl_deliver
Ctl_deliver is used to perform various administrative operations on the duplicate delivery database. Ctl_deliver reads its configuration options out of the...
ctl_mboxlist
Ctl_mboxlist is used to perform various administrative operations on the mailbox list database. Ctl_mboxlist reads its configuration options out of the...
cvt_cyrusdb
cvt_cyrusdb is used to convert a cyrusdb file between different database backends. Note that you should not attempt to use the same file for input and output...
cyr_dbtool
cyr_dbtool is used to manage a cyrusdb file. The usable actions are: show [<prefix>] get <key> set <key> <value> delete <key> consistency You may omit key or...
cyr_df
Cyr_df examines the Cyrus spool partitions and reports on their disk space usage. Cyr_df reads its configuration options out of the imapd.conf(5) file unless...
cyr_expire
Cyr_expire is used to expire messages and duplicate delivery database entries. Cyr_expire also cleanses mailboxes of partially expunged messages (when using the...
cyrfetchnews
Cyrfetchnews retrieves news articles from a peer news server and feeds them to a Cyrus server. Cyrfetchnews connects to the peer specified by peername, requests...
cyr_synclog
cyr_synclog is used to append a value to the log file. You can either specify the log type and value, or an entire log line. -u USER -v SIEVE -m MAILBOX -a...
cyrus-master
Cyrus-master is the process that controls all of the Cyrus processes. This process is responsible for creating all imapd, pop3d, lmtpd and sieved child...
deliver
Deliver reads a message from the standard input and delivers it to one or more IMAP mailboxes. Deliver reads its configuration options out of the imapd.conf(5)...
fud
FUD is a long lived datagram daemon started from master that provides information about when a user last read their mail, when mail last arrived in a user's...
idled
Idled is a long lived datagram daemon which receives notifications of mailbox changes and signals the appropriate imapd to report the changes to the client...
imapd.8cyrus
Imapd is an IMAP4rev1 server. It accepts commands on its standard input and responds on its standard output. It MUST be invoked by master(8) with those...
ipurge
Ipurge deletes messages from the mailbox(es) specified by mailbox-pattern that are older or larger than specified by the -d, -b, -k or -m options. If no...
lmtpd
Lmtpd is an LMTP server used to deliver mail to the IMAP mailstore. It accepts commands on its standard input and responds on its standard output. It MUST be...
mbexamine
Mbexamine will examine the header, index, and cache files of a cyrus format mailbox and dump the information contained therein. It can also limit its output to...
mbpath
Given a mailbox name or a space separated list of mailbox names, mbpath outputs the filesystem path to the mailbox. Mbpath reads its configuration options out...
nntpd
Nntpd is a NNTP server. It accepts commands on its standard input and responds on its standard output. It MUST invoked by master(8) with those descriptors...
notifyd
Notifyd is a daemon started from cyrus-master(8) that handles notification requests on behalf of lmtpd(8). Notifyd accepts the request and performs the...
pop3d.8cyrus
Pop3d is a POP3 server. It accepts commands on its standard input and responds on its standard output. It MUST invoked by master(8) with those descriptors...
quota
Quota generates a report listing quota roots, giving their limits and usage. If the -f option is given, quota first fixes any inconsistencies in the quota...
reconstruct
Reconstruct rebuilds one or more IMAP mailboxes. When invoked with the -m switch, it rebuilds the master mailboxes file. It can be used to recover from almost...
rmnews
Rmnews reads article data from the standard input. It then expunges and removes the listed articles. Rmnews is designed to be used by InterNetNews to remove...
smmapd
SMMAPD is a Sendmail socket map daemon which is used to verify that a Cyrus mailbox exists, that it is postable and it is under quota. It accepts commands on...
squatter
Squatter creates a new SQUAT index for one or more IMAP mailboxes. The SQUAT index is a unified index of all of the header and body text of each message a given...
sync_client
Sync_client is the client side of the replication system. It runs on the client (master) system and connects to the target (replica) system and generates an...
sync_reset
Sync_reset is a small utility program to destroy user accounts on a system. The only safeguard which is in place is the obligary force option.
sync_server
Sync_server is the server side of the the replication system. It runs on the target (replica) system and listens for connections from sync_client which provides...
timsieved
timsieved is a server that allows users to remotely manage their sieve scripts kept on the server. It accepts commands on its standard input and responds on its...
tls_prune
Tls_prune is used to prune expired sessions from the TLS sessions database. The lifetime of a TLS session is determined by the tls_session_timeout configuration...
unexpunge
Unexpunge is used to restore expunged messages which have yet to be removed from the Cyrus mailspool. This utility is only useful when the server is configured...