xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_envrcpt.html (revision e92d3f3ffe83a6ed7eaafac70da9cf4fafe13243)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>xxfi_envrcpt</title></head>
340266059SGregory Neil Shapiro<body>
4e92d3f3fSGregory Neil Shapiro<!--
5e92d3f3fSGregory Neil Shapiro$Id: xxfi_envrcpt.html,v 1.11 2003/12/30 00:19:42 gshapiro Exp $
6e92d3f3fSGregory Neil Shapiro-->
740266059SGregory Neil Shapiro<h1>xxfi_envrcpt</h1>
840266059SGregory Neil Shapiro
940266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
1140266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
1240266059SGregory Neil Shapiro<pre>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapirosfsistat (*xxfi_envrcpt)(
1540266059SGregory Neil Shapiro	SMFICTX * ctx,
1640266059SGregory Neil Shapiro	char ** argv
1740266059SGregory Neil Shapiro);
1840266059SGregory Neil Shapiro</pre>
1940266059SGregory Neil ShapiroHandle the envelope RCPT command.
2040266059SGregory Neil Shapiro</td></tr>
2140266059SGregory Neil Shapiro
2240266059SGregory Neil Shapiro<!----------- Description ---------->
2340266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
2440266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2540266059SGregory Neil Shapiro<tr align="left" valign=top>
2640266059SGregory Neil Shapiro<th width="80">Called When</th>
2740266059SGregory Neil Shapiro<td>xxfi_envrcpt is called once per recipient, hence one or more times per message, immediately after xxfi_envfrom.</td>
2840266059SGregory Neil Shapiro</tr>
2940266059SGregory Neil Shapiro<tr align="left" valign=top>
3040266059SGregory Neil Shapiro<th>Default Behavior</th>
3140266059SGregory Neil Shapiro<td>Do nothing; return SMFIS_CONTINUE.</td>
3240266059SGregory Neil Shapiro</tr>
3340266059SGregory Neil Shapiro</table>
3440266059SGregory Neil Shapiro
3540266059SGregory Neil Shapiro<!----------- Arguments ---------->
3640266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
3740266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
3840266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
3940266059SGregory Neil Shapiro    <tr valign="top"><td>ctx</td>
4040266059SGregory Neil Shapiro	<td>Opaque context structure.
4140266059SGregory Neil Shapiro	</td></tr>
4240266059SGregory Neil Shapiro    <tr valign="top"><td>argv</td>
4340266059SGregory Neil Shapiro	<td>Null-terminated SMTP command arguments;
4440266059SGregory Neil Shapiro		argv[0] is guaranteed to be the recipient address.
4540266059SGregory Neil Shapiro		Later arguments are the ESMTP arguments.
4640266059SGregory Neil Shapiro	</td></tr>
4740266059SGregory Neil Shapiro    </table>
4840266059SGregory Neil Shapiro</td></tr>
4940266059SGregory Neil Shapiro
5040266059SGregory Neil Shapiro<!----------- Return values ---------->
5140266059SGregory Neil Shapiro<tr>
5240266059SGregory Neil Shapiro<th valign="top" align=left>SPECIAL RETURN VALUES</th>
5340266059SGregory Neil Shapiro<td><table border="1" cellspacing=0>
5440266059SGregory Neil Shapiro  <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
5540266059SGregory Neil Shapiro  <tr valign="top">
5640266059SGregory Neil Shapiro     <td>SMFIS_TEMPFAIL</td>
5740266059SGregory Neil Shapiro     <td>Temporarily fail for this particular recipient; further recipients
5840266059SGregory Neil Shapiro     may still be sent.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
5940266059SGregory Neil Shapiro     </td>
6040266059SGregory Neil Shapiro  </tr>
6140266059SGregory Neil Shapiro  <tr valign="top">
6240266059SGregory Neil Shapiro     <td>SMFIS_REJECT</td>
6340266059SGregory Neil Shapiro     <td>Reject this particular recipient; further recipients may still be sent.
6440266059SGregory Neil Shapiro     <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_DISCARD</td>
6940266059SGregory Neil Shapiro     <td>Accept and discard the message.  <a href="xxfi_abort.html">xxfi_abort</a> will be called.
7040266059SGregory Neil Shapiro     </td>
7140266059SGregory Neil Shapiro  </tr>
7240266059SGregory Neil Shapiro  <tr valign="top">
7340266059SGregory Neil Shapiro     <td>SMFIS_ACCEPT</td>
7440266059SGregory Neil Shapiro     <td>Accept recipient.  <a href="xxfi_abort.html">xxfi_abort</a> will not be called.
7540266059SGregory Neil Shapiro     </td>
7640266059SGregory Neil Shapiro   </tr>
7740266059SGregory Neil Shapiro</table>
7840266059SGregory Neil Shapiro</tr>
7940266059SGregory Neil Shapiro
8040266059SGregory Neil Shapiro<!----------- Notes ---------->
8140266059SGregory Neil Shapiro<tr>
8240266059SGregory Neil Shapiro<th valign="top" align=left>NOTES</th>
8340266059SGregory Neil Shapiro<td>For more details on ESTMP responses, please see RFC
845ef517c0SGregory Neil Shapiro<a href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</a>.</td>
8540266059SGregory Neil Shapiro</tr>
8640266059SGregory Neil Shapiro</table>
8740266059SGregory Neil Shapiro
8840266059SGregory Neil Shapiro<hr size="1">
8940266059SGregory Neil Shapiro<font size="-1">
905ef517c0SGregory Neil ShapiroCopyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
9140266059SGregory Neil ShapiroAll rights reserved.
9240266059SGregory Neil Shapiro<br>
9340266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
945ef517c0SGregory Neil Shapiroforth in the LICENSE.
9540266059SGregory Neil Shapiro</font>
9640266059SGregory Neil Shapiro</body>
9740266059SGregory Neil Shapiro</html>
98