xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_addrcpt.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_addrcpt</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: smfi_addrcpt.html,v 1.12 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_addrcpt</H1>
840266059SGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapiroint smfi_addrcpt(
1540266059SGregory Neil Shapiro	SMFICTX *ctx,
1640266059SGregory Neil Shapiro	char *rcpt
1740266059SGregory Neil Shapiro);
18d0cef73dSGregory Neil Shapiro</PRE>
1940266059SGregory Neil ShapiroAdd a recipient for the current message.
20d0cef73dSGregory Neil Shapiro</TD></TR>
2140266059SGregory Neil Shapiro
2240266059SGregory Neil Shapiro<!----------- Description ---------->
23d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
25d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
26d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
27d0cef73dSGregory Neil Shapiro<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
28d0cef73dSGregory Neil Shapiro</TR>
29d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
30d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
31d0cef73dSGregory Neil Shapiro<TD>Add a recipient to the message envelope.</TD>
32d0cef73dSGregory Neil Shapiro</TR>
33d0cef73dSGregory Neil Shapiro</TABLE>
34*5b0945b5SGregory Neil Shapiro</TD></TR>
3540266059SGregory Neil Shapiro
3640266059SGregory Neil Shapiro<!----------- Arguments ---------->
37d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
39d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
41d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
42d0cef73dSGregory Neil Shapiro	</TD></TR>
43d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>rcpt</TD>
44d0cef73dSGregory Neil Shapiro	<TD>The new recipient's address.
45d0cef73dSGregory Neil Shapiro	</TD></TR>
46d0cef73dSGregory Neil Shapiro    </TABLE>
47d0cef73dSGregory Neil Shapiro</TD></TR>
4840266059SGregory Neil Shapiro
4940266059SGregory Neil Shapiro<!----------- Return values ---------->
50d0cef73dSGregory Neil Shapiro<TR>
51d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
5240266059SGregory Neil Shapiro
53d0cef73dSGregory Neil Shapiro<TD>smfi_addrcpt will fail and return MI_FAILURE if:
54d0cef73dSGregory Neil Shapiro<UL><LI>rcpt is NULL.
55d0cef73dSGregory Neil Shapiro    <LI>Adding recipients in the current connection state is invalid.
56d0cef73dSGregory Neil Shapiro    <LI>A network error occurs.
57*5b0945b5SGregory Neil Shapiro    <LI><A HREF="smfi_register.html#SMFIF_ADDRCPT">SMFIF_ADDRCPT</A> is not set.
58d0cef73dSGregory Neil Shapiro</UL>
5940266059SGregory Neil ShapiroOtherwise, it will return MI_SUCCESS.
60d0cef73dSGregory Neil Shapiro</TD>
61d0cef73dSGregory Neil Shapiro</TR>
6240266059SGregory Neil Shapiro
6340266059SGregory Neil Shapiro<!----------- Notes ---------->
64d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
65d0cef73dSGregory Neil Shapiro<TH>NOTES</TH>
66d0cef73dSGregory Neil Shapiro<TD>
67*5b0945b5SGregory Neil ShapiroA filter which calls smfi_addrcpt must have set the
68*5b0945b5SGregory Neil Shapiro<A HREF="smfi_register.html#SMFIF_ADDRCPT">SMFIF_ADDRCPT</A> flag.
69d0cef73dSGregory Neil Shapiro</TD>
70d0cef73dSGregory Neil Shapiro</TR>
7140266059SGregory Neil Shapiro
72d0cef73dSGregory Neil Shapiro</TABLE>
7340266059SGregory Neil Shapiro
74d0cef73dSGregory Neil Shapiro<HR size="1">
75d0cef73dSGregory Neil Shapiro<FONT size="-1">
765dd76dd0SGregory Neil ShapiroCopyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
7740266059SGregory Neil ShapiroAll rights reserved.
78d0cef73dSGregory Neil Shapiro<BR>
7940266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
805ef517c0SGregory Neil Shapiroforth in the LICENSE.
81d0cef73dSGregory Neil Shapiro</FONT>
82d0cef73dSGregory Neil Shapiro</BODY>
83d0cef73dSGregory Neil Shapiro</HTML>
84