summaryrefslogtreecommitdiffstats
path: root/contrib/sendmail/libmilter/docs/smfi_setconn.html
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/sendmail/libmilter/docs/smfi_setconn.html')
-rw-r--r--contrib/sendmail/libmilter/docs/smfi_setconn.html77
1 files changed, 77 insertions, 0 deletions
diff --git a/contrib/sendmail/libmilter/docs/smfi_setconn.html b/contrib/sendmail/libmilter/docs/smfi_setconn.html
new file mode 100644
index 0000000..0d46a5b
--- /dev/null
+++ b/contrib/sendmail/libmilter/docs/smfi_setconn.html
@@ -0,0 +1,77 @@
+<html>
+<head><title>smfi_setconn</title></head>
+<body>
+<h1>smfi_setconn</h1>
+
+<table border="0" cellspacing=4 cellpadding=4>
+<!---------- Synopsis ----------->
+<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
+<pre>
+#include &lt;libmilter/mfapi.h&gt;
+int smfi_setconn(
+ char *oconn;
+);
+</pre>
+Set the socket through which this filter should communicate with sendmail.
+</td></tr>
+
+<!----------- Description ---------->
+<tr><th valign="top" align=left>DESCRIPTION</th><td>
+<table border="1" cellspacing=1 cellpadding=4>
+<tr align="left" valign=top>
+<th width="80">Called When</th>
+<td>smfi_setconn must be called once before <a href="smfi_main.html">smfi_main</a>.</td>
+</tr>
+<tr align="left" valign=top>
+<th width="80">Effects</th>
+<td>Sets the socket through which the filter communicates with sendmail.</td>
+</tr>
+</table>
+
+<!----------- Arguments ---------->
+<tr><th valign="top" align=left>ARGUMENTS</th><td>
+ <table border="1" cellspacing=0>
+ <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
+ <tr valign="top"><td>oconn</td>
+ <td>The address of the desired communication socket.
+ The address should be a NULL-terminated string in "proto:address"
+ format:
+ <ul>
+ <li><code>{unix|local}:/path/to/file</code> -- A named pipe.
+ <li><code>inet:port@{hostname|ip-address}</code> -- An IPV4 socket.
+ <li><code>inet6:port@{hostname|ip-address}</code> -- An IPV6 socket.
+ </ul>
+ </td></tr>
+ </table>
+</td></tr>
+
+<!----------- Return values ---------->
+<tr>
+<th valign="top" align=left>RETURN VALUES</th>
+
+<td>smfi_setconn will not fail on an invalid address. The failure will
+only be detected in <a href="smfi_main.html">smfi_main</a></td>
+</tr>
+
+<tr>
+<th valign="top" align=left>NOTES</th>
+
+<td>
+<ul><li>If possible, filters should not run as root when communicating over unix/local domain sockets.
+ <li>Unix/local sockets should have their permissions set to 0600 (read/write permission only for the socket's owner).
+</ul>
+</td>
+</tr>
+
+</table>
+
+<hr size="1">
+<font size="-1">
+Copyright (c) 2000 Sendmail, Inc. and its suppliers.
+All rights reserved.
+<br>
+By using this file, you agree to the terms and conditions set
+forth in the <a href="LICENSE.txt">LICENSE</a>.
+</font>
+</body>
+</html>
OpenPOWER on IntegriCloud