xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_unknown.html (revision aa24f48b361effe51163877d84f1b70d32b77e04) 
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.
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
36<!----------- Arguments ---------->
37<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38    <TABLE border="1" cellspacing=0>
39    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40    <TR valign="top"><TD>ctx</TD>
41	<TD>Opaque context structure.
42	</TD></TR>
43    <TR valign="top"><TD>arg</TD>
44	<TD>SMTP command including all arguments.
45	</TD></TR>
46    </TABLE>
47</TD></TR>
48
49<!----------- Return values ---------->
50<TR>
51<TH valign="top" align=left>SPECIAL RETURN VALUES</TH>
52<TD><TABLE border="1" cellspacing=0>
53  <TR bgcolor="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
54  <TR valign="top">
55     <TD>SMFIS_TEMPFAIL</TD>
56     <TD>Reject this command with a temporary error.
57     </TD>
58  </TR>
59  <TR valign="top">
60     <TD>SMFIS_REJECT</TD>
61     <TD>Reject this command.
62     </TD>
63  </TR>
64</TABLE>
65</TR>
66
67<!----------- Notes ---------->
68<TR>
69<TH valign="top" align=left>NOTES</TH>
70<TD>The SMTP command will always be rejected by the server,
71it is only possible to return a different error code.
72</TR>
73</TABLE>
74
75<HR size="1">
76<FONT size="-1">
77Copyright (c) 2006 Proofpoint, Inc. and its suppliers.
78All rights reserved.
79<BR>
80By using this file, you agree to the terms and conditions set
81forth in the LICENSE.
82</FONT>
83</BODY>
84</HTML>
85