smfi_delrcpt.html revision 266692 
1251875Speter<HTML>
2251875Speter<HEAD><TITLE>smfi_delrcpt</TITLE></HEAD>
3251875Speter<BODY>
4251875Speter<!--
5251875Speter$Id: smfi_delrcpt.html,v 1.12 2013-11-22 20:51:39 ca Exp $
6251875Speter-->
7251875Speter<H1>smfi_delrcpt</H1>
8251875Speter
9251875Speter<TABLE border="0" cellspacing=4 cellpadding=4>
10251875Speter<!---------- Synopsis ----------->
11251875Speter<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12251875Speter<PRE>
13251875Speter#include &lt;libmilter/mfapi.h&gt;
14251875Speterint smfi_delrcpt(
15251875Speter	SMFICTX *ctx;
16251875Speter	char *rcpt;
17251875Speter);
18251875Speter</PRE>
19251875SpeterRemove a recipient from the current message's envelope.
20251875Speter</TD></TR>
21251875Speter
22251875Speter<!----------- Description ---------->
23251875Speter<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24251875Speter<TABLE border="1" cellspacing=1 cellpadding=4>
25251875Speter<TR align="left" valign=top>
26251875Speter<TH width="80">Called When</TH>
27251875Speter<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
28251875Speter</TR>
29251875Speter<TR align="left" valign=top>
30251875Speter<TH width="80">Effects</TH>
31251875Speter<TD>smfi_delrcpt removes the named recipient from the current message's envelope.</TD>
32251875Speter</TR>
33251875Speter</TABLE>
34251875Speter
35251875Speter<!----------- Arguments ---------->
36251875Speter<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37251875Speter    <TABLE border="1" cellspacing=0>
38251875Speter    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39251875Speter    <TR valign="top"><TD>ctx</TD>
40251875Speter	<TD>Opaque context structure.
41251875Speter	</TD></TR>
42251875Speter    <TR valign="top"><TD>rcpt</TD>
43251875Speter	<TD>The recipient address to be removed, a non-NULL, null-terminated string.
44251875Speter	</TD></TR>
45251875Speter    </TABLE>
46251875Speter</TD></TR>
47251875Speter
48251875Speter<!----------- Return values ---------->
49251875Speter<TR>
50251875Speter<TH valign="top" align=left>RETURN VALUES</TH> 
51251875Speter
52251875Speter<TD>smfi_delrcpt will fail and return MI_FAILURE if:
53251875Speter<UL>
54251875Speter    <LI>rcpt is NULL.
55251875Speter    <LI>Deleting recipients in the current connection state is invalid.
56251875Speter    <LI>A network error occurs.
57251875Speter    <LI>SMFIF_DELRCPT was not set when <A href="smfi_register.html">smfi_register</A> was called.
58251875Speter</UL>
59251875SpeterOtherwise, it will return MI_SUCCESS
60251875Speter</TD>
61251875Speter</TR>
62251875Speter
63251875Speter<!----------- Notes ---------->
64251875Speter<TR align="left" valign=top>
65251875Speter<TH>NOTES</TH> 
66251875Speter<TD>
67251875SpeterThe addresses to be removed must match exactly.  For example, an address and its expanded form do not match.
68251875Speter</TD>
69251875Speter</TR>
70251875Speter
71251875Speter</TABLE>
72251875Speter
73251875Speter<HR size="1">
74251875Speter<FONT size="-1">
75251875SpeterCopyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
76251875SpeterAll rights reserved.
77251875Speter<BR>
78251875SpeterBy using this file, you agree to the terms and conditions set
79251875Speterforth in the LICENSE.
80251875Speter</FONT>
81251875Speter</BODY>
82251875Speter</HTML>
83251875Speter