xxfi_envfrom.html revision 112810 
1<html>
2<head><title>xxfi_envfrom</title></head>
3<body>
4<h1>xxfi_envfrom</h1>
5
6<table border="0" cellspacing=4 cellpadding=4>
7<!---------- Synopsis ----------->
8<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
9<pre>
10#include &lt;libmilter/mfapi.h&gt;
11sfsistat (*xxfi_envfrom)(
12	SMFICTX * ctx,
13	char **	argv
14);
15</pre>
16Handle the envelope FROM command.
17</td></tr>
18
19<!----------- Description ---------->
20<tr><th valign="top" align=left>DESCRIPTION</th><td>
21<table border="1" cellspacing=1 cellpadding=4>
22<tr align="left" valign=top>
23<th width="80">Called When</th>
24<td>xxfi_envfrom is called once at the beginning of each message, before xxfi_envrcpt.</td>
25</tr>
26<tr align="left" valign=top>
27<th>Default Behavior</th>
28<td>Do nothing; return SMFIS_CONTINUE.</td>
29</tr>
30</table>
31
32<!----------- Arguments ---------->
33<tr><th valign="top" align=left>ARGUMENTS</th><td>
34    <table border="1" cellspacing=0>
35    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
36    <tr valign="top"><td>ctx</td>
37	<td>Opaque context structure.
38	</td></tr>
39    <tr valign="top"><td>argv</td>
40	<td>Null-terminated SMTP command arguments;
41		argv[0] is guaranteed to be the sender address.
42		Later arguments are the ESMTP arguments.
43	</td></tr>
44    </table>
45</td></tr>
46
47<!----------- Return values ---------->
48<tr>
49<th valign="top" align=left>SPECIAL RETURN VALUES</th>
50<td><table border="1" cellspacing=0>
51  <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
52  <tr valign="top">
53     <td>SMFIS_TEMPFAIL</td>
54     <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.
55     </td>
56  </tr>
57  <tr valign="top">
58     <td>SMFIS_REJECT</td>
59     <td>Reject this sender and message; a new sender/message may be specified.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
60     </td>
61  </tr>
62  <tr valign="top">
63     <td>SMFIS_DISCARD</td>
64     <td>Accept and silently discard this message.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
65     </td>
66  </tr>
67  <tr valign="top">
68     <td>SMFIS_ACCEPT</td>
69     <td>Accept this message.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
70     </td>
71  </tr>
72</table>
73</tr>
74
75<!----------- Notes ---------->
76<tr>
77<th valign="top" align=left>NOTES</th> 
78<td>For more details on ESTMP responses, please see RFC
79<a href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</a>.</td>
80</tr>
81</table>
82
83<hr size="1">
84<font size="-1">
85Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
86All rights reserved.
87<br>
88By using this file, you agree to the terms and conditions set
89forth in the LICENSE.
90</font>
91</body>
92</html>
93