contrib/sendmail/libmilter/docs/smfi_addrcpt_par.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_addrcpt_par</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_addrcpt_par.html,v 1.5 2013-11-22 20:51:39 ca Exp $
   6 -->
   7 <H1>smfi_addrcpt_par</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_par(
  15         SMFICTX *ctx,
  16         char *rcpt,
  17         char *args
  18 );
  19 </PRE>
  20 Add a recipient for the current message including ESMTP arguments.
  21 </TD></TR>
  22
  23 <!----------- Description ---------->
  24 <TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
  25 <TABLE border="1" cellspacing=1 cellpadding=4>
  26 <TR align="left" valign=top>
  27 <TH width="80">Called When</TH>
  28 <TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
  29 </TR>
  30 <TR align="left" valign=top>
  31 <TH width="80">Effects</TH>
  32 <TD>Add a recipient to the message envelope.</TD>
  33 </TR>
  34 </TABLE>
  35 </TD></TR>
  36
  37 <!----------- Arguments ---------->
  38 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
  39     <TABLE border="1" cellspacing=0>
  40     <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
  41     <TR valign="top"><TD>ctx</TD>
  42         <TD>Opaque context structure.
  43         </TD></TR>
  44     <TR valign="top"><TD>rcpt</TD>
  45         <TD>The new recipient's address.
  46         </TD></TR>
  47     <TR valign="top"><TD>args</TD>
  48         <TD>The new recipient's ESMTP parameters.
  49         </TD></TR>
  50     </TABLE>
  51 </TD></TR>
  52
  53 <!----------- Return values ---------->
  54 <TR>
  55 <TH valign="top" align=left>RETURN VALUES</TH>
  56
  57 <TD>smfi_addrcpt_par will fail and return MI_FAILURE if:
  58 <UL><LI>rcpt is NULL.
  59     <LI>Adding recipients in the current connection state is invalid.
  60     <LI>A network error occurs.
  61     <LI><A HREF="smfi_register.html#SMFIF_ADDRCPT_PAR">SMFIF_ADDRCPT_PAR</A> is not set._PAR
  62 </UL>
  63 Otherwise, it will return MI_SUCCESS.
  64 </TD>
  65 </TR>
  66
  67 <!----------- Notes ---------->
  68 <TR align="left" valign=top>
  69 <TH>NOTES</TH>
  70 <TD>
  71 A filter which calls smfi_addrcpt_par must have set the
  72 <A HREF="smfi_register.html#SMFIF_ADDRCPT_PAR">SMFIF_ADDRCPT_PAR</A> flag.
  73 </TD>
  74 </TR>
  75
  76 </TABLE>
  77
  78 <HR size="1">
  79 <FONT size="-1">
  80 Copyright (c) 2006 Proofpoint, Inc. and its suppliers.
  81 All rights reserved.
  82 <BR>
  83 By using this file, you agree to the terms and conditions set
  84 forth in the LICENSE.
  85 </FONT>
  86 </BODY>
  87 </HTML>