contrib/sendmail/libmilter/docs/smfi_delrcpt.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_delrcpt</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_delrcpt.html,v 1.11 2006/12/21 18:30:35 ca Exp $
   6 -->
   7 <H1>smfi_delrcpt</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_delrcpt(
  15         SMFICTX *ctx;
  16         char *rcpt;
  17 );
  18 </PRE>
  19 Remove a recipient from the current message's envelope.
  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>smfi_delrcpt removes the named recipient from the current message's 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 recipient address to be removed, a non-NULL, null-terminated string.
  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_delrcpt will fail and return MI_FAILURE if:
  53 <UL>
  54     <LI>rcpt is NULL.
  55     <LI>Deleting recipients in the current connection state is invalid.
  56     <LI>A network error occurs.
  57     <LI>SMFIF_DELRCPT was not set when <A href="smfi_register.html">smfi_register</A> was called.
  58 </UL>
  59 Otherwise, it will return MI_SUCCESS
  60 </TD>
  61 </TR>
  62
  63 <!----------- Notes ---------->
  64 <TR align="left" valign=top>
  65 <TH>NOTES</TH>
  66 <TD>
  67 The addresses to be removed must match exactly.  For example, an address and its expanded form do not match.
  68 </TD>
  69 </TR>
  70
  71 </TABLE>
  72
  73 <HR size="1">
  74 <FONT size="-1">
  75 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  76 All rights reserved.
  77 <BR>
  78 By using this file, you agree to the terms and conditions set
  79 forth in the LICENSE.
  80 </FONT>
  81 </BODY>
  82 </HTML>