xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_addrcpt_par.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_addrcpt_par</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4d0cef73dSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: smfi_addrcpt_par.html,v 1.5 2013-11-22 20:51:39 ca Exp $
6d0cef73dSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_addrcpt_par</H1>
8d0cef73dSGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
10d0cef73dSGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
13d0cef73dSGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
14d0cef73dSGregory Neil Shapiroint smfi_addrcpt_par(
15d0cef73dSGregory Neil Shapiro	SMFICTX *ctx,
16d0cef73dSGregory Neil Shapiro	char *rcpt,
17d0cef73dSGregory Neil Shapiro	char *args
18d0cef73dSGregory Neil Shapiro);
19d0cef73dSGregory Neil Shapiro</PRE>
20d0cef73dSGregory Neil ShapiroAdd a recipient for the current message including ESMTP arguments.
21d0cef73dSGregory Neil Shapiro</TD></TR>
22d0cef73dSGregory Neil Shapiro
23d0cef73dSGregory Neil Shapiro<!----------- Description ---------->
24d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
25d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
26d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
27d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
28d0cef73dSGregory Neil Shapiro<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
29d0cef73dSGregory Neil Shapiro</TR>
30d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
31d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
32d0cef73dSGregory Neil Shapiro<TD>Add a recipient to the message envelope.</TD>
33d0cef73dSGregory Neil Shapiro</TR>
34d0cef73dSGregory Neil Shapiro</TABLE>
35*5b0945b5SGregory Neil Shapiro</TD></TR>
36d0cef73dSGregory Neil Shapiro
37d0cef73dSGregory Neil Shapiro<!----------- Arguments ---------->
38d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
39d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
40d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
41d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
42d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
43d0cef73dSGregory Neil Shapiro	</TD></TR>
44d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>rcpt</TD>
45d0cef73dSGregory Neil Shapiro	<TD>The new recipient's address.
46d0cef73dSGregory Neil Shapiro	</TD></TR>
47d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>args</TD>
48d0cef73dSGregory Neil Shapiro	<TD>The new recipient's ESMTP parameters.
49d0cef73dSGregory Neil Shapiro	</TD></TR>
50d0cef73dSGregory Neil Shapiro    </TABLE>
51d0cef73dSGregory Neil Shapiro</TD></TR>
52d0cef73dSGregory Neil Shapiro
53d0cef73dSGregory Neil Shapiro<!----------- Return values ---------->
54d0cef73dSGregory Neil Shapiro<TR>
55d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
56d0cef73dSGregory Neil Shapiro
57*5b0945b5SGregory Neil Shapiro<TD>smfi_addrcpt_par will fail and return MI_FAILURE if:
58d0cef73dSGregory Neil Shapiro<UL><LI>rcpt is NULL.
59d0cef73dSGregory Neil Shapiro    <LI>Adding recipients in the current connection state is invalid.
60d0cef73dSGregory Neil Shapiro    <LI>A network error occurs.
61*5b0945b5SGregory Neil Shapiro    <LI><A HREF="smfi_register.html#SMFIF_ADDRCPT_PAR">SMFIF_ADDRCPT_PAR</A> is not set._PAR
62d0cef73dSGregory Neil Shapiro</UL>
63d0cef73dSGregory Neil ShapiroOtherwise, it will return MI_SUCCESS.
64d0cef73dSGregory Neil Shapiro</TD>
65d0cef73dSGregory Neil Shapiro</TR>
66d0cef73dSGregory Neil Shapiro
67d0cef73dSGregory Neil Shapiro<!----------- Notes ---------->
68d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
69d0cef73dSGregory Neil Shapiro<TH>NOTES</TH>
70d0cef73dSGregory Neil Shapiro<TD>
71*5b0945b5SGregory Neil ShapiroA filter which calls smfi_addrcpt_par must have set the
72*5b0945b5SGregory Neil Shapiro<A HREF="smfi_register.html#SMFIF_ADDRCPT_PAR">SMFIF_ADDRCPT_PAR</A> flag.
73d0cef73dSGregory Neil Shapiro</TD>
74d0cef73dSGregory Neil Shapiro</TR>
75d0cef73dSGregory Neil Shapiro
76d0cef73dSGregory Neil Shapiro</TABLE>
77d0cef73dSGregory Neil Shapiro
78d0cef73dSGregory Neil Shapiro<HR size="1">
79d0cef73dSGregory Neil Shapiro<FONT size="-1">
805dd76dd0SGregory Neil ShapiroCopyright (c) 2006 Proofpoint, Inc. and its suppliers.
81d0cef73dSGregory Neil ShapiroAll rights reserved.
82d0cef73dSGregory Neil Shapiro<BR>
83d0cef73dSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
84d0cef73dSGregory Neil Shapiroforth in the LICENSE.
85d0cef73dSGregory Neil Shapiro</FONT>
86d0cef73dSGregory Neil Shapiro</BODY>
87d0cef73dSGregory Neil Shapiro</HTML>
88