contrib/sendmail/libmilter/docs/xxfi_connect.html

   1 <html>
   2 <head><title>xxfi_connect</title></head>
   3 <body>
   4 <h1>xxfi_connect</h1>
   5
   6 <table border="0" cellspacing=4 cellpadding=4>
   7 <!---------- Synopsis ----------->
   8 <tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
   9 <pre>
  10 #include &lt;libmilter/mfapi.h&gt;
  11 sfsistat (*xxfi_connect)(
  12         SMFICTX    *ctx,
  13         char       *hostname,
  14         _SOCK_ADDR *hostaddr);
  15 </pre>
  16 </td></tr>
  17 <!----------- Description ---------->
  18 <tr><th valign="top" align=left>DESCRIPTION</th><td>
  19 <table border="1" cellspacing=1 cellpadding=4>
  20 <tr>
  21 <th valign="top" align=left width=80>Called When</th>
  22 <td>Once, at the start of each SMTP connection.</td>
  23 </tr>
  24 <tr>
  25 <th valign="top" align=left width=80>Default Behavior</th>
  26 <td>Do nothing; return SMFIS_CONTINUE.</td>
  27 </tr>
  28 </table>
  29 <!--
  30 This callback function is invoked on each connection to the mail
  31 filter program.  The callback is to be implemented by the Milter
  32 application developers.  The name of the callback can be any valid
  33 function name.  The function pointer is to be assigned to the
  34 smfiDesc.xxfi_connect and the pointer to the smfiDesc structure
  35 is passed to smfi_register().
  36 </td></tr>
  37 -->
  38 <!----------- Arguments ---------->
  39 <tr><th valign="top" align=left>ARGUMENTS</th><td>
  40     <table border="1" cellspacing=0>
  41     <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
  42     <tr><td>ctx</td>
  43         <td>the opaque context structure.
  44         </td></tr>
  45     <tr><td>hostname</td>
  46         <td>the host name of the message sender, as determined by a
  47             reverse lookup on the host address.  If the reverse lookup
  48             fails, hostname will contain the message sender's IP
  49             address enclosed in square brackets (e.g. `[a.b.c.d]').
  50         </td></tr>
  51     <tr><td>hostaddr</td>
  52         <td>the host address, as determined by a getpeername() call on the SMTP socket.
  53          NULL if the type is not supported in the current version or if
  54         the SMTP connection is made via stdin.
  55         </td></tr>
  56     </table>
  57 </td></tr>
  58 <!----------- Return values ---------->
  59 <!--
  60 <tr>
  61 <th valign="top" align=left>SPECIAL RETURN VALUES</th>
  62 <td><table border="1" cellspacing=0>
  63   <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
  64   <tr valign="top">
  65      <td>SMFIS_DISCARD</td>
  66      <td>Not meaningful, as
  67         this is only meaningful from message-oriented routines.
  68      </td>
  69   </tr>
  70 </table>
  71 </tr>
  72 -->
  73 <!----------- Notes ---------->
  74 <tr>
  75 <th valign="top" align=left>NOTES</th>
  76 <td>If an earlier filter rejects the connection in its xxfi_connect()
  77 routine, this filter's xxfi_connect() will not be called.</td>
  78 </tr>
  79 </table>
  80
  81 <hr size="1">
  82 <font size="-1">
  83 Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
  84 All rights reserved.
  85 <br>
  86 By using this file, you agree to the terms and conditions set
  87 forth in the LICENSE.
  88 </font>
  89 </body>
  90 </html>