Debian Codegraph @

doc/html/_sources/imap/reference/manpages/systemcommands/smmapd.rst.txt

raw
1 .. cyrusman:: smmapd(8)
2
3 .. author: Nic Bernstein (Onlight)
4
5 .. _imap-reference-manpages-systemcommands-smmapd:
6
7 ==========
8 **smmapd**
9 ==========
10
11 Sendmail and Postfix socket map daemon
12
13 Synopsis
14 ========
15
16 .. parsed-literal::
17
18 **smmapd** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ] [**-p**]
19
20 Description
21 ===========
22
23 **smmapd** is a Sendmail and Postfix socket map daemon which is used to verify
24 that a Cyrus mailbox exists, that it is postable, it is not blocked for the
25 smmapd service in the userdeny database, and it is under quota. It
26 accepts commands on its standard input and responds on its standard
27 output. It MUST be invoked by :cyrusman:`master(8)` with those
28 descriptors attached to a remote client connection. The received queries
29 contain map name followed by mailbox, **smmapd** ignores the map name.
30 Queries with plus addressing, when *-p* is not passed, return *OK* when
31 the user has a mailbox with the name after plus, otherwise the result
32 is *NOTFOUND*. Match for the mailbox after plus is performed
33 case-sensitive, for the address before the plus - depends on
34 `lmtp_downcase_rcpt`.
35
36 The use case is to verify in Sendmail or Postfix if the destination exists,
37 before accepting an email. Then, if `autocreate_sieve_folders` is set, but
38 the folder does not exist yet, **smmapd** will return *NOTFOUND*, unless *-p*
39 is passed. Another use case is to do something in a Sieve script with emails,
40 based on plus addressing, without delivering them in the correspondent sub-folder.
41 To accept such emails, when the folder with the same name does not exist, *-p* must
42 be passed.
43
44 **smmapd** |default-conf-text|
45
46 Options
47 =======
48
49 .. program:: smmapd
50
51 .. option:: -C config-file
52
53 |cli-dash-c-text|
54
55 .. option:: -U uses
56
57 The maximum number of times that the process should be used for new
58 connections before shutting down. The default is 250.
59
60 .. option:: -T timeout
61
62 The number of seconds that the process will wait for a new
63 connection before shutting down. Note that a value of 0 (zero)
64 will disable the timeout. The default is 60.
65
66 .. option:: -D
67
68 Run external debugger specified in debug_command.
69
70 .. option:: -p
71
72 Skip plus addressing: everything from `+` until `@`. When looking up the userdeny
73 database, plus addressing is always skipped, irrespective of this option.
74
75 Examples
76 ========
77
78 **smmapd** is commonly included in the SERVICES section of
79 :cyrusman:`cyrus.conf(5)` like so:
80
81 .. parsed-literal::
82 SERVICES {
83 imap cmd="imapd -U 30" listen="imap" prefork=0
84 imaps cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100
85 lmtpunix cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20
86 **smmap cmd="smmapd" listen="/var/run/cyrus/socket/smmap" prefork=0**
87 sieve cmd="timsieved" listen="sieve" prefork=0
88 notify cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1
89 httpd cmd="httpd" listen=8080 prefork=1 maxchild=20
90 }
91
92
93 Files
94 =====
95
96 /etc/imapd.conf,
97 /etc/cyrus.conf
98
99 See Also
100 ========
101
102 :cyrusman:`imapd.conf(5)`,
103 :cyrusman:`cyrus.conf(5)`