1IMAPD(8)                          Cyrus IMAP                          IMAPD(8)
2
3
4

NAME

6       imapd - Cyrus IMAP documentation
7
8       IMAP server process
9

SYNOPSIS

11       imapd [ -C config-file ] [ -U uses ] [ -T timeout ] [ -D ]
12           [ -s ] [ -N ] [ -p ssf ]
13

DESCRIPTION

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
17       cyrus-master(8) with those descriptors attached to a remote client con‐
18       nection.
19
20       imapd reads its configuration options out  of  the  imapd.conf(5)  file
21       unless specified otherwise by -C.
22
23       If  the  file  msg/shutdown is created under the directory specified in
24       the configdirectory configuration option, then imapd will shut down the
25       connection,  sending the first line contained in the file to the client
26       as the reason.  New connections are denied.
27
28       If the file msg/motd is created under the directory  specified  in  the
29       configdirectory  configuration  option,  then imapd will send the first
30       line contained in the file to clients upon connect as an ALERT  message
31       which IMAP-compliant clients are required to display.
32
33       This  option  serves to annoy users mostly.  Unfortunately clients tend
34       to connect far more frequently than is apparent, generating a  seperate
35       server  ALERT  for  each connection.  Many clients do not display these
36       properly, if they do anything with them at all.
37
38       If the directory log/user exists under the directory specified  in  the
39       configdirectory  configuration  option, then imapd will create protocol
40       telemetry logs for sessions authenticating as user.
41
42       The telemetry logs will be stored in  the  log/user  directory  with  a
43       filename of the imapd process-id.
44

OPTIONS

46       -C config-file
47              Use the specified configuration file config-file rather than the
48              default imapd.conf(5).
49
50       -U uses
51              The maximum number of times that the process should be used  for
52              new connections before shutting down.  The default is 250.
53
54       -T timeout
55              The  number of seconds that the process will wait for a new con‐
56              nection before shutting down.  Note that a  value  of  0  (zero)
57              will disable the timeout.  The default is 60.
58
59       -D     Run external debugger specified in debug_command.
60
61       -s     Serve  IMAP  over  SSL  (imaps).   All data to and from imapd is
62              encrypted using the Secure Sockets Layer.
63
64       -N     Bypass password checking.  (Not recommended unless you know what
65              you're doing.)
66
67       -p ssf Tell  imapd  that  an  external  layer exists.  An SSF (security
68              strength factor)  of  1  means  an  integrity  protection  layer
69              exists.  Any higher SSF implies some form of privacy protection.
70

EXAMPLES

72       imapd  is  commonly  included  in the SERVICES section of cyrus.conf(5)
73       like so:
74
75       SERVICES {
76           imap        cmd="imapd -U 30" listen="imap" prefork=0
77           imaps       cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100
78           lmtpunix    cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20
79           sieve       cmd="timsieved" listen="sieve" prefork=0
80           notify      cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1
81           httpd       cmd="httpd" listen=8080 prefork=1 maxchild=20
82       }
83

FILES

85       /etc/imapd.conf
86

SEE ALSO

88       imapd.conf(5), cyrus-master(8)
89

AUTHOR

91       The Cyrus Team, Nic Bernstein (Onlight)
92

94       1993-2017, The Cyrus Team
95
96
97
98
993.0.7                            May 18, 2018                         IMAPD(8)
Impressum