update manpage and homepage
[undersmtpd.git] / _smtpd.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>_smtpd - UnderSMTPD, the underscore SMTP daemon</title>
5 <link rev="made" href="mailto:root@localhost" />
6 </head>
7
8 <body style="background-color: white">
9
10 <p><a name="__index__"></a></p>
11 <!-- INDEX BEGIN -->
12
13 <ul>
14
15         <li><a href="#name">NAME</a></li>
16         <li><a href="#synopsis">SYNOPSIS</a></li>
17         <li><a href="#description">DESCRIPTION</a></li>
18         <li><a href="#options">OPTIONS</a></li>
19         <li><a href="#aliases_format">ALIASES FORMAT</a></li>
20         <li><a href="#rt_aliases_example">RT ALIASES EXAMPLE</a></li>
21         <li><a href="#bugs">BUGS</a></li>
22         <li><a href="#author">AUTHOR</a></li>
23         <li><a href="#see_also">SEE ALSO</a></li>
24 </ul>
25 <!-- INDEX END -->
26
27 <hr />
28 <p>
29 </p>
30 <h1><a name="name">NAME</a></h1>
31 <p>_smtpd - UnderSMTPD, the underscore SMTP daemon</p>
32 <p>
33 </p>
34 <hr />
35 <h1><a name="synopsis">SYNOPSIS</a></h1>
36 <pre>
37   #make some aliases
38   echo 'username: &quot;|someprogram and args&quot; &gt; /etc/aliases</pre>
39 <pre>
40   #inetd setup
41   echo &quot;smtp stream tcp nowait mail /usr/local/bin/_smtpd&quot; &gt;&gt;/etc/inetd.conf
42   echo &quot;_smtpd: my.mail.server.ip&quot;                         &gt;&gt;/etc/hosts.allow
43   echo &quot;_smtpd: ALL&quot;                                       &gt;&gt;/etc/hosts.deny</pre>
44 <pre>
45   #or add an smtp file to /etc/xinetd.d/
46   service smtp
47   {
48         socket_type = stream
49         protocol    = tcp
50         wait        = no
51         user        = mail
52         server      = /usr/local/bin/_smtpd
53   }</pre>
54 <p>
55 </p>
56 <hr />
57 <h1><a name="description">DESCRIPTION</a></h1>
58 <p>This is a minimal SMTP server which only forwards mail to pipe destinations
59 in /etc/aliases.  It does nothing else.  Its intended function is on an
60 internal mail server that forwards mail to other programs on a per address
61 basis.</p>
62 <p>UnderSMTPD reads /etc/aliases for usernames; if a match is identified
63 the message is piped to the given program.  Any problems executing the program
64 will cause a temporary SMTP error to be returned to the connecting client.</p>
65 <p>Other kinds of aliases are not recognized and cause a perminant SMTP error
66 to be returned to the connecting client, as do usernames not found in
67 /etc/aliases</p>
68 <p>UnderSMTP was originally written to be used with the Request Tracker ticketing
69 system.</p>
70 <p>UnderSMTP uses Net::SMTP::Mail to do all the hard work.</p>
71 <p>
72 </p>
73 <hr />
74 <h1><a name="options">OPTIONS</a></h1>
75 <dl>
76 <dt><strong><a name="item__2da_filename_3a_alternate_aliases_file">-a filename: Alternate aliases file</a></strong><br />
77 </dt>
78 </dl>
79 <p>
80 </p>
81 <hr />
82 <h1><a name="aliases_format">ALIASES FORMAT</a></h1>
83 <pre>
84   username: |program and args
85   username: &quot;|program and args&quot;</pre>
86 <p>Quotes are not necessary around the pipe symbol, program and arguments but are
87 stripped if present.  Line continuations are not supported.</p>
88 <p>
89 </p>
90 <hr />
91 <h1><a name="rt_aliases_example">RT ALIASES EXAMPLE</a></h1>
92 <pre>
93   support: |/opt/rt3/bin/rt-mailgate --queue support --action correspond --url <a href="http://rt.example.com/">http://rt.example.com/</a>
94   billing: |/opt/rt3/bin/rt-mailgate --queue billing --action correspond --url <a href="http://rt.example.com/">http://rt.example.com/</a></pre>
95 <p>
96 </p>
97 <hr />
98 <h1><a name="bugs">BUGS</a></h1>
99 <p>Yes.</p>
100 <p>
101 </p>
102 <hr />
103 <h1><a name="author">AUTHOR</a></h1>
104 <p>Ivan Kohler &lt;<a href="mailto:ivan-undersmtpd@420.am">ivan-undersmtpd@420.am</a>&gt;</p>
105 <p>
106 </p>
107 <hr />
108 <h1><a name="see_also">SEE ALSO</a></h1>
109 <p><a href="/Net/SMTP/Mail.html">the Net::SMTP::Mail manpage</a></p>
110
111 </body>
112
113 </html>