xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_addrcpt.html (revision e32fecd0c2c3ee37c47ee100f169e7eb0282a873)
1<HTML>
2<HEAD><TITLE>smfi_addrcpt</TITLE></HEAD>
3<BODY>
4<!--
5$Id: smfi_addrcpt.html,v 1.12 2013-11-22 20:51:39 ca Exp $
6-->
7<H1>smfi_addrcpt</H1>
8
9<TABLE border="0" cellspacing=4 cellpadding=4>
10<!---------- Synopsis ----------->
11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12<PRE>
13#include &lt;libmilter/mfapi.h&gt;
14int smfi_addrcpt(
15	SMFICTX *ctx,
16	char *rcpt
17);
18</PRE>
19Add a recipient for the current message.
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>Add a recipient to the message envelope.</TD>
32</TR>
33</TABLE>
34</TD></TR>
35
36<!----------- Arguments ---------->
37<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38    <TABLE border="1" cellspacing=0>
39    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40    <TR valign="top"><TD>ctx</TD>
41	<TD>Opaque context structure.
42	</TD></TR>
43    <TR valign="top"><TD>rcpt</TD>
44	<TD>The new recipient's address.
45	</TD></TR>
46    </TABLE>
47</TD></TR>
48
49<!----------- Return values ---------->
50<TR>
51<TH valign="top" align=left>RETURN VALUES</TH>
52
53<TD>smfi_addrcpt will fail and return MI_FAILURE if:
54<UL><LI>rcpt is NULL.
55    <LI>Adding recipients in the current connection state is invalid.
56    <LI>A network error occurs.
57    <LI><A HREF="smfi_register.html#SMFIF_ADDRCPT">SMFIF_ADDRCPT</A> is not set.
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>
67A filter which calls smfi_addrcpt must have set the
68<A HREF="smfi_register.html#SMFIF_ADDRCPT">SMFIF_ADDRCPT</A> flag.
69</TD>
70</TR>
71
72</TABLE>
73
74<HR size="1">
75<FONT size="-1">
76Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
77All rights reserved.
78<BR>
79By using this file, you agree to the terms and conditions set
80forth in the LICENSE.
81</FONT>
82</BODY>
83</HTML>
84