1168515Sgshapiro<HTML>
2168515Sgshapiro<HEAD><TITLE>smfi_chgfrom</TITLE></HEAD>
3168515Sgshapiro<BODY>
4168515Sgshapiro<!--
5266692Sgshapiro$Id: smfi_chgfrom.html,v 1.4 2013-11-22 20:51:39 ca Exp $
6168515Sgshapiro-->
7168515Sgshapiro<H1>smfi_chgfrom</H1>
8168515Sgshapiro
9168515Sgshapiro<TABLE border="0" cellspacing=4 cellpadding=4>
10168515Sgshapiro<!---------- Synopsis ----------->
11168515Sgshapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12168515Sgshapiro<PRE>
13168515Sgshapiro#include &lt;libmilter/mfapi.h&gt;
14168515Sgshapiroint smfi_chgfrom(
15168515Sgshapiro	SMFICTX *ctx,
16168515Sgshapiro	const char *mail,
17168515Sgshapiro	char *args
18168515Sgshapiro);
19168515Sgshapiro</PRE>
20168515SgshapiroChange the envelope sender (MAIL From) of the current message.
21168515Sgshapiro</TD></TR>
22168515Sgshapiro
23168515Sgshapiro<!----------- Description ---------->
24168515Sgshapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
25168515Sgshapiro<TABLE border="1" cellspacing=1 cellpadding=4>
26168515Sgshapiro<TR align="left" valign=top>
27168515Sgshapiro<TH width="80">Called When</TH>
28168515Sgshapiro<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
29168515Sgshapiro</TR>
30168515Sgshapiro<TR align="left" valign=top>
31168515Sgshapiro<TH width="80">Effects</TH>
32168515Sgshapiro<TD>Change the envelope sender (MAIL From) of the current message.</TD>
33168515Sgshapiro</TR>
34168515Sgshapiro</TABLE>
35168515Sgshapiro
36168515Sgshapiro<!----------- Arguments ---------->
37168515Sgshapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38168515Sgshapiro    <TABLE border="1" cellspacing=0>
39168515Sgshapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40168515Sgshapiro    <TR valign="top"><TD>ctx</TD>
41168515Sgshapiro	<TD>Opaque context structure.
42168515Sgshapiro	</TD></TR>
43168515Sgshapiro    <TR valign="top"><TD>mail</TD>
44168515Sgshapiro	<TD>The new sender address.
45168515Sgshapiro	</TD></TR>
46168515Sgshapiro    <TR valign="top"><TD>args</TD>
47168515Sgshapiro	<TD>ESMTP arguments.
48168515Sgshapiro	</TD></TR>
49168515Sgshapiro    </TABLE>
50168515Sgshapiro</TD></TR>
51168515Sgshapiro
52168515Sgshapiro<!----------- Return values ---------->
53168515Sgshapiro<TR>
54168515Sgshapiro<TH valign="top" align=left>RETURN VALUES</TH> 
55168515Sgshapiro
56168515Sgshapiro<TD>smfi_chgfrom will fail and return MI_FAILURE if:
57168515Sgshapiro<UL><LI>mail is NULL.
58168515Sgshapiro    <LI>Changing the sender in the current connection state is invalid.
59168515Sgshapiro    <LI>A network error occurs.
60168515Sgshapiro    <LI>SMFIF_CHGFROM was not set when <A href="smfi_register.html">smfi_register</A> was called.
61168515Sgshapiro</UL>
62168515SgshapiroOtherwise, it will return MI_SUCCESS.
63168515Sgshapiro</TD>
64168515Sgshapiro</TR>
65168515Sgshapiro
66168515Sgshapiro<!----------- Notes ---------->
67168515Sgshapiro<TR align="left" valign=top>
68168515Sgshapiro<TH>NOTES</TH> 
69168515Sgshapiro<TD>
70168515SgshapiroA filter which calls smfi_chgfrom must have set the SMFIF_CHGFROM flag
71168515Sgshapiroin the smfiDesc_str passed to 
72168515Sgshapiro<A href="smfi_register.html">smfi_register</A>.
73168515Sgshapiro<BR>
74168515SgshapiroEven though all ESMTP arguments could be set via this call,
75168515Sgshapiroit does not make sense to do so for many of them,
76168515Sgshapiroe.g., SIZE and BODY.
77168515SgshapiroSetting those may cause problems, proper care must be taken.
78168515SgshapiroMoreover, there is no feedback from the MTA to the milter
79168515Sgshapirowhether the call was successful.
80168515Sgshapiro</TD>
81168515Sgshapiro</TR>
82168515Sgshapiro
83168515Sgshapiro</TABLE>
84168515Sgshapiro
85168515Sgshapiro<HR size="1">
86168515Sgshapiro<FONT size="-1">
87261363SgshapiroCopyright (c) 2006 Proofpoint, Inc. and its suppliers.
88168515SgshapiroAll rights reserved.
89168515Sgshapiro<BR>
90168515SgshapiroBy using this file, you agree to the terms and conditions set
91168515Sgshapiroforth in the LICENSE.
92168515Sgshapiro</FONT>
93168515Sgshapiro</BODY>
94168515Sgshapiro</HTML>
95