contrib/sendmail-8.13.8/libmilter/docs/xxfi_envfrom.html

   1 <html>
   2 <head><title>xxfi_envfrom</title></head>
   3 <body>
   4 <!--
   5 $Id: xxfi_envfrom.html,v 1.9 2003/03/05 19:57:55 ca Exp $
   6 -->
   7 <h1>xxfi_envfrom</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_envfrom)(
  15         SMFICTX * ctx,
  16         char ** argv
  17 );
  18 </pre>
  19 Handle the envelope FROM 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_envfrom is called once at the beginning of each message, before xxfi_envrcpt.</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 sender 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>Reject this sender and message with a temporary error; a new sender (and hence a new message) may subsequently be specified.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
  58      </td>
  59   </tr>
  60   <tr valign="top">
  61      <td>SMFIS_REJECT</td>
  62      <td>Reject this sender and message; a new sender/message may be specified.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
  63      </td>
  64   </tr>
  65   <tr valign="top">
  66      <td>SMFIS_DISCARD</td>
  67      <td>Accept and silently discard this message.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
  68      </td>
  69   </tr>
  70   <tr valign="top">
  71      <td>SMFIS_ACCEPT</td>
  72      <td>Accept this message.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
  73      </td>
  74   </tr>
  75 </table>
  76 </tr>
  77
  78 <!----------- Notes ---------->
  79 <tr>
  80 <th valign="top" align=left>NOTES</th>
  81 <td>For more details on ESTMP responses, please see RFC
  82 <a href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</a>.</td>
  83 </tr>
  84 </table>
  85
  86 <hr size="1">
  87 <font size="-1">
  88 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  89 All rights reserved.
  90 <br>
  91 By using this file, you agree to the terms and conditions set
  92 forth in the LICENSE.
  93 </font>
  94 </body>
  95 </html>