xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_setconn.html (revision 5ef517c097100c80269c8a0e02678a89fde6b35e)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>smfi_setconn</title></head>
340266059SGregory Neil Shapiro<body>
440266059SGregory Neil Shapiro<h1>smfi_setconn</h1>
540266059SGregory Neil Shapiro
640266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
740266059SGregory Neil Shapiro<!---------- Synopsis ----------->
840266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
940266059SGregory Neil Shapiro<pre>
1040266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1140266059SGregory Neil Shapiroint smfi_setconn(
1240266059SGregory Neil Shapiro	char *oconn;
1340266059SGregory Neil Shapiro);
1440266059SGregory Neil Shapiro</pre>
1540266059SGregory Neil ShapiroSet the socket through which this filter should communicate with sendmail.
1640266059SGregory Neil Shapiro</td></tr>
1740266059SGregory Neil Shapiro
1840266059SGregory Neil Shapiro<!----------- Description ---------->
1940266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
2040266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2140266059SGregory Neil Shapiro<tr align="left" valign=top>
2240266059SGregory Neil Shapiro<th width="80">Called When</th>
2340266059SGregory Neil Shapiro<td>smfi_setconn must be called once before <a href="smfi_main.html">smfi_main</a>.</td>
2440266059SGregory Neil Shapiro</tr>
2540266059SGregory Neil Shapiro<tr align="left" valign=top>
2640266059SGregory Neil Shapiro<th width="80">Effects</th>
2740266059SGregory Neil Shapiro<td>Sets the socket through which the filter communicates with sendmail.</td>
2840266059SGregory Neil Shapiro</tr>
2940266059SGregory Neil Shapiro</table>
3040266059SGregory Neil Shapiro
3140266059SGregory Neil Shapiro<!----------- Arguments ---------->
3240266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
3340266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
3440266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
3540266059SGregory Neil Shapiro    <tr valign="top"><td>oconn</td>
3640266059SGregory Neil Shapiro	<td>The address of the desired communication socket.
3740266059SGregory Neil Shapiro	The address should be a NULL-terminated string in "proto:address"
3840266059SGregory Neil Shapiro	format:
3940266059SGregory Neil Shapiro	<ul>
4040266059SGregory Neil Shapiro	<li><code>{unix|local}:/path/to/file</code> -- A named pipe.
4140266059SGregory Neil Shapiro	<li><code>inet:port@{hostname|ip-address}</code> -- An IPV4 socket.
4240266059SGregory Neil Shapiro	<li><code>inet6:port@{hostname|ip-address}</code> -- An IPV6 socket.
4340266059SGregory Neil Shapiro	</ul>
4440266059SGregory Neil Shapiro	</td></tr>
4540266059SGregory Neil Shapiro    </table>
4640266059SGregory Neil Shapiro</td></tr>
4740266059SGregory Neil Shapiro
4840266059SGregory Neil Shapiro<!----------- Return values ---------->
4940266059SGregory Neil Shapiro<tr>
5040266059SGregory Neil Shapiro<th valign="top" align=left>RETURN VALUES</th>
5140266059SGregory Neil Shapiro
525ef517c0SGregory Neil Shapiro<td>smfi_setconn will not fail on an invalid address.
535ef517c0SGregory Neil ShapiroThe failure will only be detected in <a href="smfi_main.html">smfi_main</a></td>.
545ef517c0SGregory Neil ShapiroNevertheless, smfi_setconn may fail for other reasons, e.g.,
555ef517c0SGregory Neil Shapirodue to a lack of memory.
5640266059SGregory Neil Shapiro</tr>
5740266059SGregory Neil Shapiro
5840266059SGregory Neil Shapiro<tr>
5940266059SGregory Neil Shapiro<th valign="top" align=left>NOTES</th>
6040266059SGregory Neil Shapiro
6140266059SGregory Neil Shapiro<td>
625ef517c0SGregory Neil Shapiro<ul>
635ef517c0SGregory Neil Shapiro  <li>If possible, filters should not run as root when communicating
645ef517c0SGregory Neil Shapiro	over unix/local domain sockets.
655ef517c0SGregory Neil Shapiro  <li>Unix/local sockets should have their permissions set to
665ef517c0SGregory Neil Shapiro	0600 (read/write permission only for the socket's owner) or
675ef517c0SGregory Neil Shapiro	0660 (read/write permission for the socket's owner and group)
685ef517c0SGregory Neil Shapiro	which is useful if the sendmail RunAsUser option is used.
695ef517c0SGregory Neil Shapiro	The permissions for a unix/local domain socket are determined as
705ef517c0SGregory Neil Shapiro	usual by <code>umask</code>, which should be set to 007 or 077
715ef517c0SGregory Neil Shapiro	before calling <code>smfi_setconn()</code>.
7240266059SGregory Neil Shapiro</ul>
7340266059SGregory Neil Shapiro</td>
7440266059SGregory Neil Shapiro</tr>
7540266059SGregory Neil Shapiro
7640266059SGregory Neil Shapiro</table>
7740266059SGregory Neil Shapiro
7840266059SGregory Neil Shapiro<hr size="1">
7940266059SGregory Neil Shapiro<font size="-1">
805ef517c0SGregory Neil ShapiroCopyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
8140266059SGregory Neil ShapiroAll rights reserved.
8240266059SGregory Neil Shapiro<br>
8340266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
845ef517c0SGregory Neil Shapiroforth in the LICENSE.
8540266059SGregory Neil Shapiro</font>
8640266059SGregory Neil Shapiro</body>
8740266059SGregory Neil Shapiro</html>
88