aboutsummaryrefslogtreecommitdiff
path: root/contrib/sendmail/libmilter/docs/smfi_setconn.html
blob: 70a510e3ea1d524142a7053174076a6c3001b5d5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<HTML>
<HEAD><TITLE>smfi_setconn</TITLE></HEAD>
<BODY>
<!--
$Id: smfi_setconn.html,v 1.17 2006/12/21 18:30:35 ca Exp $
-->
<H1>smfi_setconn</H1>

<TABLE border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<TR><TH valign="top" align=left width=100>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>.
Nevertheless, smfi_setconn may fail for other reasons, e.g.,
due to a lack of memory.
</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) or
	0660 (read/write permission for the socket's owner and group)
	which is useful if the sendmail RunAsUser option is used.
	The permissions for a unix/local domain socket are determined as
	usual by <CODE>umask</CODE>, which should be set to 007 or 077.
        Note some operating systems (e.g, Solaris) don't use the
        permissions of the socket.  On those systems, place the socket in a
        protected directory.
</UL>
</TD>
</TR>

</TABLE>

<HR size="1">
<FONT size="-1">
Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
All rights reserved.
<BR>
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
</FONT>
</BODY>
</HTML>