xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envfrom.html (revision 5ef517c097100c80269c8a0e02678a89fde6b35e)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>xxfi_envfrom</title></head>
340266059SGregory Neil Shapiro<body>
440266059SGregory Neil Shapiro<h1>xxfi_envfrom</h1>
540266059SGregory Neil Shapiro
640266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
740266059SGregory Neil Shapiro<!---------- Synopsis ----------->
840266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
940266059SGregory Neil Shapiro<pre>
1040266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1140266059SGregory Neil Shapirosfsistat (*xxfi_envfrom)(
1240266059SGregory Neil Shapiro	SMFICTX * ctx,
1340266059SGregory Neil Shapiro	char **	argv
1440266059SGregory Neil Shapiro);
1540266059SGregory Neil Shapiro</pre>
1640266059SGregory Neil ShapiroHandle the envelope FROM command.
1740266059SGregory Neil Shapiro</td></tr>
1840266059SGregory Neil Shapiro
1940266059SGregory Neil Shapiro<!----------- Description ---------->
2040266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
2140266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2240266059SGregory Neil Shapiro<tr align="left" valign=top>
2340266059SGregory Neil Shapiro<th width="80">Called When</th>
2440266059SGregory Neil Shapiro<td>xxfi_envfrom is called once at the beginning of each message, before xxfi_envrcpt.</td>
2540266059SGregory Neil Shapiro</tr>
2640266059SGregory Neil Shapiro<tr align="left" valign=top>
2740266059SGregory Neil Shapiro<th>Default Behavior</th>
2840266059SGregory Neil Shapiro<td>Do nothing; return SMFIS_CONTINUE.</td>
2940266059SGregory Neil Shapiro</tr>
3040266059SGregory Neil Shapiro</table>
3140266059SGregory Neil Shapiro
3240266059SGregory Neil Shapiro<!----------- Arguments ---------->
3340266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
3440266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
3540266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
3640266059SGregory Neil Shapiro    <tr valign="top"><td>ctx</td>
3740266059SGregory Neil Shapiro	<td>Opaque context structure.
3840266059SGregory Neil Shapiro	</td></tr>
3940266059SGregory Neil Shapiro    <tr valign="top"><td>argv</td>
4040266059SGregory Neil Shapiro	<td>Null-terminated SMTP command arguments;
4140266059SGregory Neil Shapiro		argv[0] is guaranteed to be the sender address.
4240266059SGregory Neil Shapiro		Later arguments are the ESMTP arguments.
4340266059SGregory Neil Shapiro	</td></tr>
4440266059SGregory Neil Shapiro    </table>
4540266059SGregory Neil Shapiro</td></tr>
4640266059SGregory Neil Shapiro
4740266059SGregory Neil Shapiro<!----------- Return values ---------->
4840266059SGregory Neil Shapiro<tr>
4940266059SGregory Neil Shapiro<th valign="top" align=left>SPECIAL RETURN VALUES</th>
5040266059SGregory Neil Shapiro<td><table border="1" cellspacing=0>
5140266059SGregory Neil Shapiro  <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
5240266059SGregory Neil Shapiro  <tr valign="top">
5340266059SGregory Neil Shapiro     <td>SMFIS_TEMPFAIL</td>
5440266059SGregory 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.
5540266059SGregory Neil Shapiro     </td>
5640266059SGregory Neil Shapiro  </tr>
5740266059SGregory Neil Shapiro  <tr valign="top">
5840266059SGregory Neil Shapiro     <td>SMFIS_REJECT</td>
5940266059SGregory 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.
6040266059SGregory Neil Shapiro     </td>
6140266059SGregory Neil Shapiro  </tr>
6240266059SGregory Neil Shapiro  <tr valign="top">
6340266059SGregory Neil Shapiro     <td>SMFIS_DISCARD</td>
6440266059SGregory Neil Shapiro     <td>Accept and silently discard this message.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
6540266059SGregory Neil Shapiro     </td>
6640266059SGregory Neil Shapiro  </tr>
6740266059SGregory Neil Shapiro  <tr valign="top">
6840266059SGregory Neil Shapiro     <td>SMFIS_ACCEPT</td>
6940266059SGregory Neil Shapiro     <td>Accept this message.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
7040266059SGregory Neil Shapiro     </td>
7140266059SGregory Neil Shapiro  </tr>
7240266059SGregory Neil Shapiro</table>
7340266059SGregory Neil Shapiro</tr>
7440266059SGregory Neil Shapiro
7540266059SGregory Neil Shapiro<!----------- Notes ---------->
7640266059SGregory Neil Shapiro<tr>
7740266059SGregory Neil Shapiro<th valign="top" align=left>NOTES</th>
7840266059SGregory Neil Shapiro<td>For more details on ESTMP responses, please see RFC
795ef517c0SGregory Neil Shapiro<a href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</a>.</td>
8040266059SGregory Neil Shapiro</tr>
8140266059SGregory Neil Shapiro</table>
8240266059SGregory Neil Shapiro
8340266059SGregory Neil Shapiro<hr size="1">
8440266059SGregory Neil Shapiro<font size="-1">
855ef517c0SGregory Neil ShapiroCopyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
8640266059SGregory Neil ShapiroAll rights reserved.
8740266059SGregory Neil Shapiro<br>
8840266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
895ef517c0SGregory Neil Shapiroforth in the LICENSE.
9040266059SGregory Neil Shapiro</font>
9140266059SGregory Neil Shapiro</body>
9240266059SGregory Neil Shapiro</html>
93