xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envfrom.html (revision 7ef62cebc2f965b0f640263e179276928885e33d)
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</TD></TR>
37
38<!----------- Arguments ---------->
39<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
40    <TABLE border="1" cellspacing=0>
41    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
42    <TR valign="top"><TD>ctx</TD>
43	<TD>Opaque context structure.
44	</TD></TR>
45    <TR valign="top"><TD>argv</TD>
46	<TD>Null-terminated SMTP command arguments;
47		argv[0] is guaranteed to be the sender address.
48		Later arguments are the ESMTP arguments.
49	</TD></TR>
50    </TABLE>
51</TD></TR>
52
53<!----------- Return values ---------->
54<TR>
55<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
56<TD><TABLE border="1" cellspacing=0>
57  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
58  <TR valign="top">
59     <TD>SMFIS_TEMPFAIL</TD>
60     <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.
61     </TD>
62  </TR>
63  <TR valign="top">
64     <TD>SMFIS_REJECT</TD>
65     <TD>Reject this sender and message; a new sender/message may be specified.  <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 silently discard this message.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
71     </TD>
72  </TR>
73  <TR valign="top">
74     <TD>SMFIS_ACCEPT</TD>
75     <TD>Accept this message.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
76     </TD>
77  </TR>
78</TABLE>
79</TD></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, 2006 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