aboutsummaryrefslogtreecommitdiff
path: root/contrib/sendmail/libmilter/docs/xxfi_envfrom.html
blob: 6ae88cff6fc0767f1b9d2c067d08442ba884ff92 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<HTML>
<HEAD><TITLE>xxfi_envfrom</TITLE></HEAD>
<BODY>
<!--
$Id: xxfi_envfrom.html,v 1.14 2007/01/25 01:00:20 ca Exp $
-->
<H1>xxfi_envfrom</H1>

<TABLE border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
<PRE>
#include &lt;libmilter/mfapi.h&gt;
sfsistat (*xxfi_envfrom)(
	SMFICTX *ctx,
	char **argv
);
</PRE>
Handle the MAIL (envelope sender) command.
</TD></TR>

<!----------- Description ---------->
<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
<TABLE border="1" cellspacing=1 cellpadding=4>
<TR align="left" valign=top>
<TH width="80">Called When</TH>
<TD>xxfi_envfrom is called once at the beginning of each message
(MAIL command),
before xxfi_envrcpt.</TD>
</TR>
<TR align="left" valign=top>
<TH>Default Behavior</TH>
<TD>Do nothing; return SMFIS_CONTINUE.</TD>
</TR>
</TABLE>

<!----------- Arguments ---------->
<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
    <TABLE border="1" cellspacing=0>
    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
    <TR valign="top"><TD>ctx</TD>
	<TD>Opaque context structure.
	</TD></TR>
    <TR valign="top"><TD>argv</TD>
	<TD>Null-terminated SMTP command arguments;
		argv[0] is guaranteed to be the sender address.
		Later arguments are the ESMTP arguments.
	</TD></TR>
    </TABLE>
</TD></TR>

<!----------- Return values ---------->
<TR>
<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
<TD><TABLE border="1" cellspacing=0>
  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
  <TR valign="top">
     <TD>SMFIS_TEMPFAIL</TD>
     <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.
     </TD>
  </TR>
  <TR valign="top">
     <TD>SMFIS_REJECT</TD>
     <TD>Reject this sender and message; a new sender/message may be specified.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
     </TD>
  </TR>
  <TR valign="top">
     <TD>SMFIS_DISCARD</TD>
     <TD>Accept and silently discard this message.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
     </TD>
  </TR>
  <TR valign="top">
     <TD>SMFIS_ACCEPT</TD>
     <TD>Accept this message.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
     </TD>
  </TR>
</TABLE>
</TR>

<!----------- Notes ---------->
<TR>
<TH valign="top" align=left>NOTES</TH> 
<TD>For more details on ESMTP responses, please see RFC
<A href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</A>.</TD>
</TR>
</TABLE>

<HR size="1">
<FONT size="-1">
Copyright (c) 2000, 2003, 2006 Sendmail, Inc. and its suppliers.
All rights reserved.
<BR>
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
</FONT>
</BODY>
</HTML>