smfi_delrcpt.html revision 256281 
1139743Simp<HTML>
243412Snewton<HEAD><TITLE>smfi_delrcpt</TITLE></HEAD>
343412Snewton<BODY>
443412Snewton<!--
543412Snewton$Id: smfi_delrcpt.html,v 1.11 2006/12/21 18:30:35 ca Exp $
643412Snewton-->
743412Snewton<H1>smfi_delrcpt</H1>
843412Snewton
943412Snewton<TABLE border="0" cellspacing=4 cellpadding=4>
1043412Snewton<!---------- Synopsis ----------->
1143412Snewton<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
1243412Snewton<PRE>
1343412Snewton#include &lt;libmilter/mfapi.h&gt;
1443412Snewtonint smfi_delrcpt(
1543412Snewton	SMFICTX *ctx;
1643412Snewton	char *rcpt;
1743412Snewton);
1843412Snewton</PRE>
1943412SnewtonRemove a recipient from the current message's envelope.
2043412Snewton</TD></TR>
2143412Snewton
2243412Snewton<!----------- Description ---------->
2343412Snewton<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
2443412Snewton<TABLE border="1" cellspacing=1 cellpadding=4>
2543412Snewton<TR align="left" valign=top>
2643412Snewton<TH width="80">Called When</TH>
2749267Snewton<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
2850477Speter</TR>
2943412Snewton<TR align="left" valign=top>
3043412Snewton<TH width="80">Effects</TH>
3143412Snewton<TD>smfi_delrcpt removes the named recipient from the current message's envelope.</TD>
3243412Snewton</TR>
3343412Snewton</TABLE>
3465302Sobrien
3543412Snewton<!----------- Arguments ---------->
3643412Snewton<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
3743412Snewton    <TABLE border="1" cellspacing=0>
3843412Snewton    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
3943412Snewton    <TR valign="top"><TD>ctx</TD>
4043412Snewton	<TD>Opaque context structure.
4143412Snewton	</TD></TR>
4243412Snewton    <TR valign="top"><TD>rcpt</TD>
4343412Snewton	<TD>The recipient address to be removed, a non-NULL, null-terminated string.
4443412Snewton	</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>
59Otherwise, it will return MI_SUCCESS
60</TD>
61</TR>
62
63<!----------- Notes ---------->
64<TR align="left" valign=top>
65<TH>NOTES</TH> 
66<TD>
67The 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">
75Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
76All rights reserved.
77<BR>
78By using this file, you agree to the terms and conditions set
79forth in the LICENSE.
80</FONT>
81</BODY>
82</HTML>
83