smfi_delrcpt.html revision 132943 
1<html>
2<head><title>smfi_delrcpt</title></head>
3<body>
4<!--
5$Id: smfi_delrcpt.html,v 1.9 2003/10/27 15:51:12 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=150>SYNOPSIS</th><td>
12<pre>
13#include &lt;libmilter/mfapi.h&gt;
14int smfi_delrcpt(
15	SMFICTX *ctx;
16	char *rcpt;
17);
18</pre>
19Remove 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>
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