contrib/sendmail-8.13.4/libmilter/docs/xxfi_envrcpt.html

   1 <html>
   2 <head><title>xxfi_envrcpt</title></head>
   3 <body>
   4 <!--
   5 $Id: xxfi_envrcpt.html,v 1.11 2003/12/30 00:19:42 gshapiro Exp $
   6 -->
   7 <h1>xxfi_envrcpt</h1>
   8
   9 <table border="0" cellspacing=4 cellpadding=4>
  10 <!---------- Synopsis ----------->
  11 <tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
  12 <pre>
  13 #include &lt;libmilter/mfapi.h&gt;
  14 sfsistat (*xxfi_envrcpt)(
  15         SMFICTX * ctx,
  16         char ** argv
  17 );
  18 </pre>
  19 Handle the envelope RCPT command.
  20 </td></tr>
  21
  22 <!----------- Description ---------->
  23 <tr><th valign="top" align=left>DESCRIPTION</th><td>
  24 <table border="1" cellspacing=1 cellpadding=4>
  25 <tr align="left" valign=top>
  26 <th width="80">Called When</th>
  27 <td>xxfi_envrcpt is called once per recipient, hence one or more times per message, immediately after xxfi_envfrom.</td>
  28 </tr>
  29 <tr align="left" valign=top>
  30 <th>Default Behavior</th>
  31 <td>Do nothing; return SMFIS_CONTINUE.</td>
  32 </tr>
  33 </table>
  34
  35 <!----------- Arguments ---------->
  36 <tr><th valign="top" align=left>ARGUMENTS</th><td>
  37     <table border="1" cellspacing=0>
  38     <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
  39     <tr valign="top"><td>ctx</td>
  40         <td>Opaque context structure.
  41         </td></tr>
  42     <tr valign="top"><td>argv</td>
  43         <td>Null-terminated SMTP command arguments;
  44                 argv[0] is guaranteed to be the recipient address.
  45                 Later arguments are the ESMTP arguments.
  46         </td></tr>
  47     </table>
  48 </td></tr>
  49
  50 <!----------- Return values ---------->
  51 <tr>
  52 <th valign="top" align=left>SPECIAL RETURN VALUES</th>
  53 <td><table border="1" cellspacing=0>
  54   <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
  55   <tr valign="top">
  56      <td>SMFIS_TEMPFAIL</td>
  57      <td>Temporarily fail for this particular recipient; further recipients
  58      may still be sent.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
  59      </td>
  60   </tr>
  61   <tr valign="top">
  62      <td>SMFIS_REJECT</td>
  63      <td>Reject this particular recipient; further recipients may still be sent.
  64      <a href="xxfi_abort.html">xxfi_abort</a> is not called.
  65      </td>
  66   </tr>
  67   <tr valign="top">
  68      <td>SMFIS_DISCARD</td>
  69      <td>Accept and discard the message.  <a href="xxfi_abort.html">xxfi_abort</a> will be called.
  70      </td>
  71   </tr>
  72   <tr valign="top">
  73      <td>SMFIS_ACCEPT</td>
  74      <td>Accept recipient.  <a href="xxfi_abort.html">xxfi_abort</a> will not be called.
  75      </td>
  76    </tr>
  77 </table>
  78 </tr>
  79
  80 <!----------- Notes ---------->
  81 <tr>
  82 <th valign="top" align=left>NOTES</th>
  83 <td>For more details on ESTMP responses, please see RFC
  84 <a href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</a>.</td>
  85 </tr>
  86 </table>
  87
  88 <hr size="1">
  89 <font size="-1">
  90 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  91 All rights reserved.
  92 <br>
  93 By using this file, you agree to the terms and conditions set
  94 forth in the LICENSE.
  95 </font>
  96 </body>
  97 </html>