summaryrefslogtreecommitdiff
path: root/gnu/usr.sbin/sendmail/libmilter/docs/xxfi_envrcpt.html
blob: 9d32e90962c428904c37d65d90fdeb2d8d80d5ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<html>
<head><title>xxfi_envrcpt</title></head>
<body>
<h1>xxfi_envrcpt</h1>

<table border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
<pre>
#include &lt;libmilter/mfapi.h&gt;
sfsistat (*xxfi_envrcpt)(
	SMFICTX * ctx,
	char ** argv
);
</pre>
Handle the envelope RCPT command.
</td></tr>

<!----------- Description ---------->
<tr><th valign="top" align=left>DESCRIPTION</th><td>
<table border="1" cellspacing=1 cellpadding=4>
<tr align="left" valign=top>
<th width="80">Called When</th>
<td>xxfi_envrcpt is called once per recipient, hence one or more times per message, immediately after xxfi_envfrom.</td>
</tr>
<tr align="left" valign=top>
<th>Default Behavior</th>
<td>Do nothing; return SMFIS_CONTINUE.</td>
</tr>
</table>

<!----------- Arguments ---------->
<tr><th valign="top" align=left>ARGUMENTS</th><td>
    <table border="1" cellspacing=0>
    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
    <tr valign="top"><td>ctx</td>
	<td>Opaque context structure.
	</td></tr>
    <tr valign="top"><td>argv</td>
	<td>Null-terminated SMTP command arguments;
		argv[0] is guaranteed to be the recipient address.
		Later arguments are the ESMTP arguments.
	</td></tr>
    </table>
</td></tr>

<!----------- Return values ---------->
<tr>
<th valign="top" align=left>SPECIAL RETURN VALUES</th>
<td><table border="1" cellspacing=0>
  <tr bgcolor="#dddddd"><th>Return value</th><th>Description</th></tr>
  <tr valign="top">
     <td>SMFIS_TEMPFAIL</td>
     <td>Temporarily fail for this particular recipient; further recipients 
     maystill be sent.  <a href="xxfi_abort.html">xxfi_abort</a> is not called.
     </td>
  </tr>
  <tr valign="top">
     <td>SMFIS_REJECT</td>
     <td>Reject this particular recipient; further recipients maystill be sent.
     <a href="xxfi_abort.html">xxfi_abort</a> is not called.
     </td>
  </tr>
  <tr valign="top">
     <td>SMFIS_DISCARD</td>
     <td>Accept and discard the message.  <a href="xxfi_abort.html">xxfi_abort</a> will be called.
     </td>
  </tr>
  <tr valign="top">
     <td>SMFIS_ACCEPT</td>
     <td>Accept recipient.  <a href="xxfi_abort.html">xxfi_abort</a> will not be called.
     </td>
   </tr>
</table>
</tr>

<!----------- Notes ---------->
<tr>
<th valign="top" align=left>NOTES</th> 
<td>For more details on ESTMP responses, please see RFC
<a href="http://www.rfc-editor.org/rfc/rfc1869.txt">1869</a>.</td>
</tr>
</table>

<hr size="1">
<font size="-1">
Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
</font>
</body>
</html>