1IMAPD(8)                    System Manager's Manual                   IMAPD(8)
2
3
4
5 *
6

NAME

8       imapd - 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  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.   This  option
31       serves  to  annoy  users mostly.  Unfortunately clients tend to connect
32       far more frequently than is apparent, causing each connection to gener‐
33       ate  a  seperate server ALERT for each connection.  Many clients do not
34       display these properly, if they do anything with them at all.
35
36       If the directory log/user exists under the directory specified  in  the
37       configdirectory  configuration  option, then imapd will create protocol
38       telemetry logs for sessions authenticating as user.  The telemetry logs
39       will  be  stored in the log/user directory with a filename of the imapd
40       process-id.
41

OPTIONS

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

FILES

68       /etc/imapd.conf
69

SEE ALSO

71       imapd.conf(5), cyrus-master(8)
72
73
74
75CMU                              Project Cyrus                        IMAPD(8)