1 files changed, 73 insertions, 0 deletions
diff --git a/sendmail/libmilter/docs/smfi_quarantine.html b/sendmail/libmilter/docs/smfi_quarantine.html
new file mode 100644
index 000000000000..656a480d0122
--- /dev/null
+++ b/sendmail/libmilter/docs/smfi_quarantine.html
@@ -0,0 +1,73 @@
+<HTML>
+<HEAD><TITLE>smfi_quarantine</TITLE></HEAD>
+<BODY>
+<!--
+$Id: smfi_quarantine.html,v 1.5 2006/12/21 18:30:35 ca Exp $
+-->
+<H1>smfi_quarantine</H1>
+
+<TABLE border="0" cellspacing=4 cellpadding=4>
+<!---------- Synopsis ----------->
+<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
+<PRE>
+#include &lt;libmilter/mfapi.h&gt;
+int smfi_quarantine(
+	SMFICTX *ctx;
+	char *reason;
+);
+</PRE>
+Quarantine the message using the given reason.
+</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>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
+</TR>
+<TR align="left" valign=top>
+<TH width="80">Effects</TH>
+<TD>smfi_quarantine quarantines the message using the given reason.</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>reason</TD>
+	<TD>The quarantine reason, a non-NULL and non-empty null-terminated string.
+	</TD></TR>
+    </TABLE>
+</TD></TR>
+
+<!----------- Return values ---------->
+<TR>
+<TH valign="top" align=left>RETURN VALUES</TH> 
+
+<TD>smfi_quarantine will fail and return MI_FAILURE if:
+<UL>
+    <LI>reason is NULL or empty.
+    <LI>A network error occurs.
+    <LI>SMFIF_QUARANTINE was not set when <A href="smfi_register.html">smfi_register</A> was called.
+</UL>
+Otherwise, it will return MI_SUCCESS
+</TD>
+</TR>
+
+</TABLE>
+
+<HR size="1">
+<FONT size="-1">
+Copyright (c) 2002-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>