smfi_addrcpt.html revision 112810 
1<html>
2<head><title>smfi_addrcpt</title></head>
3<body>
4<h1>smfi_addrcpt</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_addrcpt(
12	SMFICTX *ctx,
13	char *rcpt
14);
15</pre>
16Add a recipient for the current message.
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>Add a recipient to the message 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 new recipient's address.
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_addrcpt will fail and return MI_FAILURE if:
50<ul><li>rcpt is NULL.
51    <li>Adding headers in the current connection state is invalid.
52    <li>A network error occurs.
53    <li>SMFIF_ADDRCPT was not set when <a href="smfi_register.html">smfi_register</a> was called.
54</ul>
55Otherwise, it will return MI_SUCCESS.
56</td>
57</tr>
58
59<!----------- Notes ---------->
60<tr align="left" valign=top>
61<th>NOTES</th> 
62<td>
63A filter which calls smfi_addrcpt must have set the SMFIF_ADDRCPT flag
64in the smfiDesc_str passed to 
65<a href="smfi_register.html">smfi_register</a>.
66</td>
67</tr>
68
69</table>
70
71<hr size="1">
72<font size="-1">
73Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
74All rights reserved.
75<br>
76By using this file, you agree to the terms and conditions set
77forth in the LICENSE.
78</font>
79</body>
80</html>
81