smfi_delrcpt.html revision 90792 
1<html>
2<head><title>smfi_delrcpt</title></head>
3<body>
4<h1>smfi_delrcpt</h1>
5
6<table border="0" cellspacing=4 cellpadding=4>
7<!---------- Synopsis ----------->
8<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
9<pre>
10#include &lt;libmilter/mfapi.h&gt;
11int smfi_delrcpt(
12	SMFICTX *ctx;
13	char *rcpt;
14);
15</pre>
16Remove a recipient from the current message's envelope.
17</td></tr>
18
19<!----------- Description ---------->
20<tr><th valign="top" align=left>DESCRIPTION</th><td>
21<table border="1" cellspacing=1 cellpadding=4>
22<tr align="left" valign=top>
23<th width="80">Called When</th>
24<td>Called only from <a href="xxfi_eom.html">xxfi_eom</a>.</td>
25</tr>
26<tr align="left" valign=top>
27<th width="80">Effects</th>
28<td>smfi_delrcpt removes the named recipient from the current message's envelope.</td>
29</tr>
30</table>
31
32<!----------- Arguments ---------->
33<tr><th valign="top" align=left>ARGUMENTS</th><td>
34    <table border="1" cellspacing=0>
35    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
36    <tr valign="top"><td>ctx</td>
37	<td>Opaque context structure.
38	</td></tr>
39    <tr valign="top"><td>rcpt</td>
40	<td>The recipient address to be removed, a non-NULL, null-terminated string.
41	</td></tr>
42    </table>
43</td></tr>
44
45<!----------- Return values ---------->
46<tr>
47<th valign="top" align=left>RETURN VALUES</th> 
48
49<td>smfi_delrcpt will fail and return MI_FAILURE if:
50<ul>
51    <li>rcpt is NULL.
52    <li>Adding headers in the current connection state is invalid.
53    <li>A network error occurs.
54    <li>SMFIF_DELRCPT was not set when <a href="smfi_register.html">smfi_register</a> was called.
55</ul>
56Otherwise, it will return MI_SUCCESS
57</td>
58</tr>
59
60<!----------- Notes ---------->
61<tr align="left" valign=top>
62<th>NOTES</th> 
63<td>
64The addresses to be removed must match exactly.  For example, an address and its expanded form do not match.
65</td>
66</tr>
67
68</table>
69
70<hr size="1">
71<font size="-1">
72Copyright (c) 2000 Sendmail, Inc. and its suppliers.
73All rights reserved.
74<br>
75By using this file, you agree to the terms and conditions set
76forth in the <a href="LICENSE.txt">LICENSE</a>.
77</font>
78</body>
79</html>
80