xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_connect.html (revision 5ef517c097100c80269c8a0e02678a89fde6b35e)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>xxfi_connect</title></head>
340266059SGregory Neil Shapiro<body>
440266059SGregory Neil Shapiro<h1>xxfi_connect</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 Shapirosfsistat (*xxfi_connect)(
1240266059SGregory Neil Shapiro        SMFICTX    *ctx,
1340266059SGregory Neil Shapiro        char       *hostname,
1440266059SGregory Neil Shapiro        _SOCK_ADDR *hostaddr);
1540266059SGregory Neil Shapiro</pre>
1640266059SGregory Neil Shapiro</td></tr>
1740266059SGregory Neil Shapiro<!----------- Description ---------->
1840266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
1940266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2040266059SGregory Neil Shapiro<tr>
2140266059SGregory Neil Shapiro<th valign="top" align=left width=80>Called When</th>
2240266059SGregory Neil Shapiro<td>Once, at the start of each SMTP connection.</td>
2340266059SGregory Neil Shapiro</tr>
2440266059SGregory Neil Shapiro<tr>
2540266059SGregory Neil Shapiro<th valign="top" align=left width=80>Default Behavior</th>
2640266059SGregory Neil Shapiro<td>Do nothing; return SMFIS_CONTINUE.</td>
2740266059SGregory Neil Shapiro</tr>
2840266059SGregory Neil Shapiro</table>
2940266059SGregory Neil Shapiro<!--
3040266059SGregory Neil ShapiroThis callback function is invoked on each connection to the mail
3140266059SGregory Neil Shapirofilter program.  The callback is to be implemented by the Milter
3240266059SGregory Neil Shapiroapplication developers.  The name of the callback can be any valid
3340266059SGregory Neil Shapirofunction name.  The function pointer is to be assigned to the
3440266059SGregory Neil ShapirosmfiDesc.xxfi_connect and the pointer to the smfiDesc structure
3540266059SGregory Neil Shapirois passed to smfi_register().
3640266059SGregory Neil Shapiro</td></tr>
3740266059SGregory Neil Shapiro-->
3840266059SGregory Neil Shapiro<!----------- Arguments ---------->
3940266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
4040266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
4140266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
4240266059SGregory Neil Shapiro    <tr><td>ctx</td>
4340266059SGregory Neil Shapiro	<td>the opaque context structure.
4440266059SGregory Neil Shapiro	</td></tr>
4540266059SGregory Neil Shapiro    <tr><td>hostname</td>
4640266059SGregory Neil Shapiro	<td>the host name of the message sender, as determined by a
4740266059SGregory Neil Shapiro	    reverse lookup on the host address.  If the reverse lookup
4840266059SGregory Neil Shapiro	    fails, hostname will contain the message sender's IP
4940266059SGregory Neil Shapiro	    address enclosed in square brackets (e.g. `[a.b.c.d]').
5040266059SGregory Neil Shapiro	</td></tr>
5140266059SGregory Neil Shapiro    <tr><td>hostaddr</td>
5240266059SGregory Neil Shapiro	<td>the host address, as determined by a getpeername() call on the SMTP socket.
5340266059SGregory Neil Shapiro	 NULL if the type is not supported in the current version or if
5440266059SGregory Neil Shapiro	the SMTP connection is made via stdin.
5540266059SGregory Neil Shapiro	</td></tr>
5640266059SGregory Neil Shapiro    </table>
5740266059SGregory Neil Shapiro</td></tr>
5840266059SGregory Neil Shapiro<!----------- Return values ---------->
5940266059SGregory Neil Shapiro<!--
6040266059SGregory Neil Shapiro<tr>
6140266059SGregory Neil Shapiro<th valign="top" align=left>SPECIAL RETURN VALUES</th>
6240266059SGregory Neil Shapiro<td><table border="1" cellspacing=0>
6340266059SGregory Neil Shapiro  <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
6440266059SGregory Neil Shapiro  <tr valign="top">
6540266059SGregory Neil Shapiro     <td>SMFIS_DISCARD</td>
6640266059SGregory Neil Shapiro     <td>Not meaningful, as
6740266059SGregory Neil Shapiro        this is only meaningful from message-oriented routines.
6840266059SGregory Neil Shapiro     </td>
6940266059SGregory Neil Shapiro  </tr>
7040266059SGregory Neil Shapiro</table>
7140266059SGregory Neil Shapiro</tr>
7240266059SGregory Neil Shapiro-->
7340266059SGregory Neil Shapiro<!----------- Notes ---------->
7440266059SGregory Neil Shapiro<tr>
7540266059SGregory Neil Shapiro<th valign="top" align=left>NOTES</th>
7640266059SGregory Neil Shapiro<td>If an earlier filter rejects the connection in its xxfi_connect()
7740266059SGregory Neil Shapiroroutine, this filter's xxfi_connect() will not be called.</td>
7840266059SGregory Neil Shapiro</tr>
7940266059SGregory Neil Shapiro</table>
8040266059SGregory Neil Shapiro
8140266059SGregory Neil Shapiro<hr size="1">
8240266059SGregory Neil Shapiro<font size="-1">
835ef517c0SGregory Neil ShapiroCopyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
8440266059SGregory Neil ShapiroAll rights reserved.
8540266059SGregory Neil Shapiro<br>
8640266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
875ef517c0SGregory Neil Shapiroforth in the LICENSE.
8840266059SGregory Neil Shapiro</font>
8940266059SGregory Neil Shapiro</body>
9040266059SGregory Neil Shapiro</html>
91