xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envrcpt.html (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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</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>argv</TD>
44	<TD>Null-terminated SMTP command arguments;
45		argv[0] is guaranteed to be the recipient address.
46		Later arguments are the ESMTP arguments.
47	</TD></TR>
48    </TABLE>
49</TD></TR>
50
51<!----------- Return values ---------->
52<TR>
53<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
54<TD><TABLE border="1" cellspacing=0>
55  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
56  <TR valign="top">
57     <TD>SMFIS_TEMPFAIL</TD>
58     <TD>Temporarily fail for this particular recipient; further recipients
59     may still be sent.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
60     </TD>
61  </TR>
62  <TR valign="top">
63     <TD>SMFIS_REJECT</TD>
64     <TD>Reject this particular recipient; further recipients may still be sent.
65     <A href="xxfi_abort.html">xxfi_abort</A> is not called.
66     </TD>
67  </TR>
68  <TR valign="top">
69     <TD>SMFIS_DISCARD</TD>
70     <TD>Accept and discard the message.  <A href="xxfi_abort.html">xxfi_abort</A> will be called.
71     </TD>
72  </TR>
73  <TR valign="top">
74     <TD>SMFIS_ACCEPT</TD>
75     <TD>Accept this message.
76     <A href="xxfi_abort.html">xxfi_abort</A> will not be called.
77     </TD>
78   </TR>
79</TABLE>
80</TD></TR>
81
82<!----------- Notes ---------->
83<TR>
84<TH valign="top" align=left>NOTES</TH>
85<TD>For more details on ESMTP responses, please see RFC
86<A href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</A>.</TD>
87</TR>
88</TABLE>
89
90<HR size="1">
91<FONT size="-1">
92Copyright (c) 2000, 2003, 2010 Proofpoint, Inc. and its suppliers.
93All rights reserved.
94<BR>
95By using this file, you agree to the terms and conditions set
96forth in the LICENSE.
97</FONT>
98</BODY>
99</HTML>
100