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