xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envfrom.html (revision d0cef73d40a409e3116f095b83633b1364e95741)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>xxfi_envfrom</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
5d0cef73dSGregory Neil Shapiro$Id: xxfi_envfrom.html,v 1.14 2007/01/25 01:00:20 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>xxfi_envfrom</H1>
840266059SGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapirosfsistat (*xxfi_envfrom)(
1540266059SGregory Neil Shapiro	SMFICTX *ctx,
1640266059SGregory Neil Shapiro	char **argv
1740266059SGregory Neil Shapiro);
18d0cef73dSGregory Neil Shapiro</PRE>
19d0cef73dSGregory Neil ShapiroHandle the MAIL (envelope sender) command.
20d0cef73dSGregory Neil Shapiro</TD></TR>
2140266059SGregory Neil Shapiro
2240266059SGregory Neil Shapiro<!----------- Description ---------->
23d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
25d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
26d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
27d0cef73dSGregory Neil Shapiro<TD>xxfi_envfrom is called once at the beginning of each message
28d0cef73dSGregory Neil Shapiro(MAIL command),
29d0cef73dSGregory Neil Shapirobefore xxfi_envrcpt.</TD>
30d0cef73dSGregory Neil Shapiro</TR>
31d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
32d0cef73dSGregory Neil Shapiro<TH>Default Behavior</TH>
33d0cef73dSGregory Neil Shapiro<TD>Do nothing; return SMFIS_CONTINUE.</TD>
34d0cef73dSGregory Neil Shapiro</TR>
35d0cef73dSGregory Neil Shapiro</TABLE>
3640266059SGregory Neil Shapiro
3740266059SGregory Neil Shapiro<!----------- Arguments ---------->
38d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
39d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
40d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
41d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
42d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
43d0cef73dSGregory Neil Shapiro	</TD></TR>
44d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>argv</TD>
45d0cef73dSGregory Neil Shapiro	<TD>Null-terminated SMTP command arguments;
4640266059SGregory Neil Shapiro		argv[0] is guaranteed to be the sender address.
4740266059SGregory Neil Shapiro		Later arguments are the ESMTP arguments.
48d0cef73dSGregory Neil Shapiro	</TD></TR>
49d0cef73dSGregory Neil Shapiro    </TABLE>
50d0cef73dSGregory Neil Shapiro</TD></TR>
5140266059SGregory Neil Shapiro
5240266059SGregory Neil Shapiro<!----------- Return values ---------->
53d0cef73dSGregory Neil Shapiro<TR>
54d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
55d0cef73dSGregory Neil Shapiro<TD><TABLE border="1" cellspacing=0>
56d0cef73dSGregory Neil Shapiro  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
57d0cef73dSGregory Neil Shapiro  <TR valign="top">
58d0cef73dSGregory Neil Shapiro     <TD>SMFIS_TEMPFAIL</TD>
59d0cef73dSGregory Neil Shapiro     <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.
60d0cef73dSGregory Neil Shapiro     </TD>
61d0cef73dSGregory Neil Shapiro  </TR>
62d0cef73dSGregory Neil Shapiro  <TR valign="top">
63d0cef73dSGregory Neil Shapiro     <TD>SMFIS_REJECT</TD>
64d0cef73dSGregory Neil Shapiro     <TD>Reject this sender and message; a new sender/message may be specified.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
65d0cef73dSGregory Neil Shapiro     </TD>
66d0cef73dSGregory Neil Shapiro  </TR>
67d0cef73dSGregory Neil Shapiro  <TR valign="top">
68d0cef73dSGregory Neil Shapiro     <TD>SMFIS_DISCARD</TD>
69d0cef73dSGregory Neil Shapiro     <TD>Accept and silently discard this message.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
70d0cef73dSGregory Neil Shapiro     </TD>
71d0cef73dSGregory Neil Shapiro  </TR>
72d0cef73dSGregory Neil Shapiro  <TR valign="top">
73d0cef73dSGregory Neil Shapiro     <TD>SMFIS_ACCEPT</TD>
74d0cef73dSGregory Neil Shapiro     <TD>Accept this message.  <A href="xxfi_abort.html">xxfi_abort</A> is not called.
75d0cef73dSGregory Neil Shapiro     </TD>
76d0cef73dSGregory Neil Shapiro  </TR>
77d0cef73dSGregory Neil Shapiro</TABLE>
78d0cef73dSGregory Neil Shapiro</TR>
7940266059SGregory Neil Shapiro
8040266059SGregory Neil Shapiro<!----------- Notes ---------->
81d0cef73dSGregory Neil Shapiro<TR>
82d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>NOTES</TH>
83d0cef73dSGregory Neil Shapiro<TD>For more details on ESMTP responses, please see RFC
84d0cef73dSGregory Neil Shapiro<A href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</A>.</TD>
85d0cef73dSGregory Neil Shapiro</TR>
86d0cef73dSGregory Neil Shapiro</TABLE>
8740266059SGregory Neil Shapiro
88d0cef73dSGregory Neil Shapiro<HR size="1">
89d0cef73dSGregory Neil Shapiro<FONT size="-1">
90d0cef73dSGregory Neil ShapiroCopyright (c) 2000, 2003, 2006 Sendmail, Inc. and its suppliers.
9140266059SGregory Neil ShapiroAll rights reserved.
92d0cef73dSGregory Neil Shapiro<BR>
9340266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
945ef517c0SGregory Neil Shapiroforth in the LICENSE.
95d0cef73dSGregory Neil Shapiro</FONT>
96d0cef73dSGregory Neil Shapiro</BODY>
97d0cef73dSGregory Neil Shapiro</HTML>
98