contrib/sendmail/libmilter/docs/smfi_addrcpt.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_addrcpt</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_addrcpt.html,v 1.11 2006/12/21 18:30:35 ca 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=100>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>