xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envrcpt.html (revision 09a53ad8f1318c5daae6cfb19d97f4f6459f0013)
1<HTML>
2<HEAD><TITLE>xxfi_envrcpt</TITLE></HEAD>
3<BODY>
4<!--
5$Id: xxfi_envrcpt.html,v 1.17 2013-11-22 20:51:39 ca Exp $
6-->
7<H1>xxfi_envrcpt</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;
14sfsistat (*xxfi_envrcpt)(
15	SMFICTX *ctx,
16	char **argv
17);
18</PRE>
19Handle the envelope RCPT command.
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>xxfi_envrcpt is called once per recipient, hence one or more times per message, immediately after xxfi_envfrom.</TD>
28</TR>
29<TR align="left" valign=top>
30<TH>Default Behavior</TH>
31<TD>Do nothing; return SMFIS_CONTINUE.</TD>
32</TR>
33</TABLE>
34
35<!----------- Arguments ---------->
36<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37    <TABLE border="1" cellspacing=0>
38    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39    <TR valign="top"><TD>ctx</TD>
40	<TD>Opaque context structure.
41	</TD></TR>
42    <TR valign="top"><TD>argv</TD>
43	<TD>Null-terminated SMTP command arguments;
44		argv[0] is guaranteed to be the recipient address.
45		Later arguments are the ESMTP arguments.
46	</TD></TR>
47    </TABLE>
48</TD></TR>
49
50<!----------- Return values ---------->
51<TR>
52<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
53<TD><TABLE border="1" cellspacing=0>
54  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
55  <TR valign="top">
56     <TD>SMFIS_TEMPFAIL</TD>
57     <TD>Temporarily fail for this particular recipient; further recipients
58     may still be sent.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
59     </TD>
60  </TR>
61  <TR valign="top">
62     <TD>SMFIS_REJECT</TD>
63     <TD>Reject this particular recipient; further recipients may still be sent.
64     <A href="xxfi_abort.html">xxfi_abort</A> is not called.
65     </TD>
66  </TR>
67  <TR valign="top">
68     <TD>SMFIS_DISCARD</TD>
69     <TD>Accept and discard the message.  <A href="xxfi_abort.html">xxfi_abort</A> will be called.
70     </TD>
71  </TR>
72  <TR valign="top">
73     <TD>SMFIS_ACCEPT</TD>
74     <TD>Accept this message.
75     <A href="xxfi_abort.html">xxfi_abort</A> will not be called.
76     </TD>
77   </TR>
78</TABLE>
79</TR>
80
81<!----------- Notes ---------->
82<TR>
83<TH valign="top" align=left>NOTES</TH>
84<TD>For more details on ESMTP responses, please see RFC
85<A href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</A>.</TD>
86</TR>
87</TABLE>
88
89<HR size="1">
90<FONT size="-1">
91Copyright (c) 2000, 2003, 2010 Proofpoint, Inc. and its suppliers.
92All rights reserved.
93<BR>
94By using this file, you agree to the terms and conditions set
95forth in the LICENSE.
96</FONT>
97</BODY>
98</HTML>
99