contrib/sendmail-8.13.7/libmilter/docs/smfi_addrcpt.html

   1 <html>
   2 <head><title>smfi_addrcpt</title></head>
   3 <body>
   4 <!--
   5 $Id: smfi_addrcpt.html,v 1.9 2003/10/08 17:55:00 gshapiro Exp $
   6 -->
   7 <h1>smfi_addrcpt</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 int smfi_addrcpt(
  15         SMFICTX *ctx,
  16         char *rcpt
  17 );
  18 </pre>
  19 Add a recipient for the current message.
  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>Called only from <a href="xxfi_eom.html">xxfi_eom</a>.</td>
  28 </tr>
  29 <tr align="left" valign=top>
  30 <th width="80">Effects</th>
  31 <td>Add a recipient to the message envelope.</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>rcpt</td>
  43         <td>The new recipient's address.
  44         </td></tr>
  45     </table>
  46 </td></tr>
  47
  48 <!----------- Return values ---------->
  49 <tr>
  50 <th valign="top" align=left>RETURN VALUES</th>
  51
  52 <td>smfi_addrcpt will fail and return MI_FAILURE if:
  53 <ul><li>rcpt is NULL.
  54     <li>Adding recipients in the current connection state is invalid.
  55     <li>A network error occurs.
  56     <li>SMFIF_ADDRCPT was not set when <a href="smfi_register.html">smfi_register</a> was called.
  57 </ul>
  58 Otherwise, it will return MI_SUCCESS.
  59 </td>
  60 </tr>
  61
  62 <!----------- Notes ---------->
  63 <tr align="left" valign=top>
  64 <th>NOTES</th>
  65 <td>
  66 A filter which calls smfi_addrcpt must have set the SMFIF_ADDRCPT flag
  67 in the smfiDesc_str passed to
  68 <a href="smfi_register.html">smfi_register</a>.
  69 </td>
  70 </tr>
  71
  72 </table>
  73
  74 <hr size="1">
  75 <font size="-1">
  76 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  77 All rights reserved.
  78 <br>
  79 By using this file, you agree to the terms and conditions set
  80 forth in the LICENSE.
  81 </font>
  82 </body>
  83 </html>