xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envrcpt.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>xxfi_envrcpt</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: xxfi_envrcpt.html,v 1.17 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>xxfi_envrcpt</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 Shapirosfsistat (*xxfi_envrcpt)(
1540266059SGregory Neil Shapiro	SMFICTX *ctx,
1640266059SGregory Neil Shapiro	char **argv
1740266059SGregory Neil Shapiro);
18d0cef73dSGregory Neil Shapiro</PRE>
1940266059SGregory Neil ShapiroHandle the envelope RCPT command.
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>xxfi_envrcpt is called once per recipient, hence one or more times per message, immediately after xxfi_envfrom.</TD>
28d0cef73dSGregory Neil Shapiro</TR>
29d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
30d0cef73dSGregory Neil Shapiro<TH>Default Behavior</TH>
31d0cef73dSGregory Neil Shapiro<TD>Do nothing; return SMFIS_CONTINUE.</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>argv</TD>
44d0cef73dSGregory Neil Shapiro	<TD>Null-terminated SMTP command arguments;
4540266059SGregory Neil Shapiro		argv[0] is guaranteed to be the recipient address.
4640266059SGregory Neil Shapiro		Later arguments are the ESMTP arguments.
47d0cef73dSGregory Neil Shapiro	</TD></TR>
48d0cef73dSGregory Neil Shapiro    </TABLE>
49d0cef73dSGregory Neil Shapiro</TD></TR>
5040266059SGregory Neil Shapiro
5140266059SGregory Neil Shapiro<!----------- Return values ---------->
52d0cef73dSGregory Neil Shapiro<TR>
53d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
54d0cef73dSGregory Neil Shapiro<TD><TABLE border="1" cellspacing=0>
55d0cef73dSGregory Neil Shapiro  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
56d0cef73dSGregory Neil Shapiro  <TR valign="top">
57d0cef73dSGregory Neil Shapiro     <TD>SMFIS_TEMPFAIL</TD>
58d0cef73dSGregory Neil Shapiro     <TD>Temporarily fail for this particular recipient; further recipients
59d0cef73dSGregory Neil Shapiro     may still be sent.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
60d0cef73dSGregory Neil Shapiro     </TD>
61d0cef73dSGregory Neil Shapiro  </TR>
62d0cef73dSGregory Neil Shapiro  <TR valign="top">
63d0cef73dSGregory Neil Shapiro     <TD>SMFIS_REJECT</TD>
64d0cef73dSGregory Neil Shapiro     <TD>Reject this particular recipient; further recipients may still be sent.
65d0cef73dSGregory Neil Shapiro     <A href="xxfi_abort.html">xxfi_abort</A> is not called.
66d0cef73dSGregory Neil Shapiro     </TD>
67d0cef73dSGregory Neil Shapiro  </TR>
68d0cef73dSGregory Neil Shapiro  <TR valign="top">
69d0cef73dSGregory Neil Shapiro     <TD>SMFIS_DISCARD</TD>
70d0cef73dSGregory Neil Shapiro     <TD>Accept and discard the message.  <A href="xxfi_abort.html">xxfi_abort</A> will be called.
71d0cef73dSGregory Neil Shapiro     </TD>
72d0cef73dSGregory Neil Shapiro  </TR>
73d0cef73dSGregory Neil Shapiro  <TR valign="top">
74d0cef73dSGregory Neil Shapiro     <TD>SMFIS_ACCEPT</TD>
756f9c8e5bSGregory Neil Shapiro     <TD>Accept this message.
766f9c8e5bSGregory Neil Shapiro     <A href="xxfi_abort.html">xxfi_abort</A> will not be called.
77d0cef73dSGregory Neil Shapiro     </TD>
78d0cef73dSGregory Neil Shapiro   </TR>
79d0cef73dSGregory Neil Shapiro</TABLE>
80*5b0945b5SGregory Neil Shapiro</TD></TR>
8140266059SGregory Neil Shapiro
8240266059SGregory Neil Shapiro<!----------- Notes ---------->
83d0cef73dSGregory Neil Shapiro<TR>
84d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>NOTES</TH>
85d0cef73dSGregory Neil Shapiro<TD>For more details on ESMTP responses, please see RFC
86d0cef73dSGregory Neil Shapiro<A href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</A>.</TD>
87d0cef73dSGregory Neil Shapiro</TR>
88d0cef73dSGregory Neil Shapiro</TABLE>
8940266059SGregory Neil Shapiro
90d0cef73dSGregory Neil Shapiro<HR size="1">
91d0cef73dSGregory Neil Shapiro<FONT size="-1">
925dd76dd0SGregory Neil ShapiroCopyright (c) 2000, 2003, 2010 Proofpoint, Inc. and its suppliers.
9340266059SGregory Neil ShapiroAll rights reserved.
94d0cef73dSGregory Neil Shapiro<BR>
9540266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
965ef517c0SGregory Neil Shapiroforth in the LICENSE.
97d0cef73dSGregory Neil Shapiro</FONT>
98d0cef73dSGregory Neil Shapiro</BODY>
99d0cef73dSGregory Neil Shapiro</HTML>
100