xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_unknown.html (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1<HTML>
2<HEAD><TITLE>xxfi_unknown</TITLE></HEAD>
3<BODY>
4<!--
5$Id: xxfi_unknown.html,v 1.5 2013-11-22 20:51:39 ca Exp $
6-->
7<H1>xxfi_unknown</H1>
8
9<TABLE border="0" cellspacing=4 cellpadding=4>
10<!---------- Synopsis ----------->
11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12<PRE>
13#include &lt;libmilter/mfapi.h&gt;
14sfsistat (*xxfi_unknown)(
15	SMFICTX *ctx,
16	const char *arg
17);
18</PRE>
19Handle unknown and unimplemented SMTP commands.
20</TD></TR>
21
22<!----------- Description ---------->
23<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24<TABLE border="1" cellspacing=1 cellpadding=4>
25<TR align="left" valign=top>
26<TH width="80">Called When</TH>
27<TD>xxfi_unknown is called when the client uses an SMTP command
28that is either unknown or not implemented by the MTA.</TD>
29</TR>
30<TR align="left" valign=top>
31<TH>Default Behavior</TH>
32<TD>Do nothing; return SMFIS_CONTINUE.</TD>
33</TR>
34</TABLE>
35</TD></TR>
36
37<!----------- Arguments ---------->
38<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
39    <TABLE border="1" cellspacing=0>
40    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
41    <TR valign="top"><TD>ctx</TD>
42	<TD>Opaque context structure.
43	</TD></TR>
44    <TR valign="top"><TD>arg</TD>
45	<TD>SMTP command including all arguments.
46	</TD></TR>
47    </TABLE>
48</TD></TR>
49
50<!----------- Return values ---------->
51<TR>
52<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
53<TD><TABLE border="1" cellspacing=0>
54  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
55  <TR valign="top">
56     <TD>SMFIS_TEMPFAIL</TD>
57     <TD>Reject this command with a temporary error.
58     </TD>
59  </TR>
60  <TR valign="top">
61     <TD>SMFIS_REJECT</TD>
62     <TD>Reject this command.
63     </TD>
64  </TR>
65</TABLE>
66</TD></TR>
67
68<!----------- Notes ---------->
69<TR>
70<TH valign="top" align=left>NOTES</TH>
71<TD>The SMTP command will always be rejected by the server,
72it is only possible to return a different error code.</TD>
73</TR>
74</TABLE>
75
76<HR size="1">
77<FONT size="-1">
78Copyright (c) 2006 Proofpoint, Inc. and its suppliers.
79All rights reserved.
80<BR>
81By using this file, you agree to the terms and conditions set
82forth in the LICENSE.
83</FONT>
84</BODY>
85</HTML>
86