smfi_delrcpt.html revision 261363 
121308Sache<HTML>
221308Sache<HEAD><TITLE>smfi_delrcpt</TITLE></HEAD>
321308Sache<BODY>
421308Sache<!--
521308Sache$Id: smfi_delrcpt.html,v 1.12 2013/11/22 20:51:39 ca Exp $
621308Sache-->
721308Sache<H1>smfi_delrcpt</H1>
821308Sache
921308Sache<TABLE border="0" cellspacing=4 cellpadding=4>
1021308Sache<!---------- Synopsis ----------->
1121308Sache<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
1221308Sache<PRE>
1321308Sache#include &lt;libmilter/mfapi.h&gt;
1421308Sacheint smfi_delrcpt(
1521308Sache	SMFICTX *ctx;
1621308Sache	char *rcpt;
1721308Sache);
1821308Sache</PRE>
1921308SacheRemove a recipient from the current message's envelope.
2021308Sache</TD></TR>
2121308Sache
2221308Sache<!----------- Description ---------->
2321308Sache<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
2421308Sache<TABLE border="1" cellspacing=1 cellpadding=4>
2521308Sache<TR align="left" valign=top>
2621308Sache<TH width="80">Called When</TH>
2721308Sache<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
2821308Sache</TR>
2921308Sache<TR align="left" valign=top>
3021308Sache<TH width="80">Effects</TH>
3121308Sache<TD>smfi_delrcpt removes the named recipient from the current message's envelope.</TD>
3221308Sache</TR>
3321308Sache</TABLE>
3421308Sache
3521308Sache<!----------- Arguments ---------->
3621308Sache<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
3721308Sache    <TABLE border="1" cellspacing=0>
3821308Sache    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
3921308Sache    <TR valign="top"><TD>ctx</TD>
4021308Sache	<TD>Opaque context structure.
4121308Sache	</TD></TR>
4221308Sache    <TR valign="top"><TD>rcpt</TD>
4321308Sache	<TD>The recipient address to be removed, a non-NULL, null-terminated string.
4421308Sache	</TD></TR>
4521308Sache    </TABLE>
4621308Sache</TD></TR>
4721308Sache
4821308Sache<!----------- Return values ---------->
4921308Sache<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 Proofpoint, 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