1IMAPD(8) Cyrus IMAP IMAPD(8)
2
3
4
6 imapd - Cyrus IMAP documentation
7
8 IMAP server process
9
11 imapd [ -C config-file ] [ -U uses ] [ -T timeout ] [ -D ]
12 [ -s ] [ -N ] [ -p ssf ]
13
15 imapd is an IMAP4rev1 server. It accepts commands on its standard
16 input and responds on its standard output. It MUST be invoked by mas‐
17 ter(8) with those descriptors attached to a remote client connection.
18
19 imapd reads its configuration options out of the imapd.conf(5) file
20 unless specified otherwise by -C.
21
22 If the file msg/shutdown is created under the directory specified in
23 the configdirectory configuration option, then imapd will shut down the
24 connection, sending the first line contained in the file to the client
25 as the reason. New connections are denied.
26
27 If the file msg/motd is created under the directory specified in the
28 configdirectory configuration option, then imapd will send the first
29 line contained in the file to clients upon connect as an ALERT message
30 which IMAP-compliant clients are required to display.
31
32 This option serves to annoy users mostly. Unfortunately clients tend
33 to connect far more frequently than is apparent, generating a seperate
34 server ALERT for each connection. Many clients do not display these
35 properly, if they do anything with them at all.
36
37 If the directory log/user exists under the directory specified in the
38 configdirectory configuration option, then imapd will create protocol
39 telemetry logs for sessions authenticating as user.
40
41 The telemetry logs will be stored in the log/user directory with a
42 filename of the imapd process-id.
43
45 -C config-file
46 Use the specified configuration file config-file rather than the
47 default imapd.conf(5).
48
49 -U uses
50 The maximum number of times that the process should be used for
51 new connections before shutting down. The default is 250.
52
53 -T timeout
54 The number of seconds that the process will wait for a new con‐
55 nection before shutting down. Note that a value of 0 (zero)
56 will disable the timeout. The default is 60.
57
58 -D Run external debugger specified in debug_command.
59
60 -s Serve IMAP over SSL (imaps). All data to and from imapd is
61 encrypted using the Secure Sockets Layer.
62
63 -N Bypass password checking. (Not recommended unless you know what
64 you're doing.)
65
66 -p ssf Tell imapd that an external layer exists. An SSF (security
67 strength factor) of 1 means an integrity protection layer
68 exists. Any higher SSF implies some form of privacy protection.
69
71 imapd is commonly included in the SERVICES section of cyrus.conf(5)
72 like so:
73
74 SERVICES {
75 imap cmd="imapd -U 30" listen="imap" prefork=0
76 imaps cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100
77 lmtpunix cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20
78 sieve cmd="timsieved" listen="sieve" prefork=0
79 notify cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1
80 httpd cmd="httpd" listen=8080 prefork=1 maxchild=20
81 }
82
84 /etc/imapd.conf
85
87 imapd.conf(5), master(8)
88
90 The Cyrus Team, Nic Bernstein (Onlight)
91
93 1993-2017, The Cyrus Team
94
95
96
97
983.0.10 May 27, 2019 IMAPD(8)