1275970Scy<HTML>
2275970Scy<HEAD><TITLE>smfi_delrcpt</TITLE></HEAD>
3275970Scy<BODY>
4275970Scy<!--
5275970Scy$Id: smfi_delrcpt.html,v 1.11 2006/12/21 18:30:35 ca Exp $
6275970Scy-->
7275970Scy<H1>smfi_delrcpt</H1>
8275970Scy
9275970Scy<TABLE border="0" cellspacing=4 cellpadding=4>
10275970Scy<!---------- Synopsis ----------->
11275970Scy<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12275970Scy<PRE>
13275970Scy#include &lt;libmilter/mfapi.h&gt;
14275970Scyint smfi_delrcpt(
15275970Scy	SMFICTX *ctx;
16275970Scy	char *rcpt;
17275970Scy);
18275970Scy</PRE>
19275970ScyRemove a recipient from the current message's envelope.
20275970Scy</TD></TR>
21275970Scy
22275970Scy<!----------- Description ---------->
23275970Scy<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24275970Scy<TABLE border="1" cellspacing=1 cellpadding=4>
25275970Scy<TR align="left" valign=top>
26275970Scy<TH width="80">Called When</TH>
27275970Scy<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
28275970Scy</TR>
29275970Scy<TR align="left" valign=top>
30275970Scy<TH width="80">Effects</TH>
31275970Scy<TD>smfi_delrcpt removes the named recipient from the current message's envelope.</TD>
32275970Scy</TR>
33275970Scy</TABLE>
34275970Scy
35275970Scy<!----------- Arguments ---------->
36275970Scy<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37275970Scy    <TABLE border="1" cellspacing=0>
38275970Scy    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39275970Scy    <TR valign="top"><TD>ctx</TD>
40275970Scy	<TD>Opaque context structure.
41275970Scy	</TD></TR>
42275970Scy    <TR valign="top"><TD>rcpt</TD>
43275970Scy	<TD>The recipient address to be removed, a non-NULL, null-terminated string.
44275970Scy	</TD></TR>
45275970Scy    </TABLE>
46275970Scy</TD></TR>
47275970Scy
48275970Scy<!----------- Return values ---------->
49275970Scy<TR>
50275970Scy<TH valign="top" align=left>RETURN VALUES</TH> 
51275970Scy
52275970Scy<TD>smfi_delrcpt will fail and return MI_FAILURE if:
53275970Scy<UL>
54275970Scy    <LI>rcpt is NULL.
55275970Scy    <LI>Deleting recipients in the current connection state is invalid.
56275970Scy    <LI>A network error occurs.
57275970Scy    <LI>SMFIF_DELRCPT was not set when <A href="smfi_register.html">smfi_register</A> was called.
58275970Scy</UL>
59275970ScyOtherwise, it will return MI_SUCCESS
60275970Scy</TD>
61275970Scy</TR>
62275970Scy
63275970Scy<!----------- Notes ---------->
64275970Scy<TR align="left" valign=top>
65275970Scy<TH>NOTES</TH> 
66275970Scy<TD>
67275970ScyThe addresses to be removed must match exactly.  For example, an address and its expanded form do not match.
68275970Scy</TD>
69275970Scy</TR>
70275970Scy
71275970Scy</TABLE>
72275970Scy
73275970Scy<HR size="1">
74275970Scy<FONT size="-1">
75275970ScyCopyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
76275970ScyAll rights reserved.
77275970Scy<BR>
78275970ScyBy using this file, you agree to the terms and conditions set
79275970Scyforth in the LICENSE.
80275970Scy</FONT>
81275970Scy</BODY>
82275970Scy</HTML>
83275970Scy