1168515Sgshapiro<HTML>
2168515Sgshapiro<HEAD><TITLE>smfi_quarantine</TITLE></HEAD>
3168515Sgshapiro<BODY>
4132943Sgshapiro<!--
5168515Sgshapiro$Id: smfi_quarantine.html,v 1.5 2006/12/21 18:30:35 ca Exp $
6132943Sgshapiro-->
7168515Sgshapiro<H1>smfi_quarantine</H1>
8132943Sgshapiro
9168515Sgshapiro<TABLE border="0" cellspacing=4 cellpadding=4>
10132943Sgshapiro<!---------- Synopsis ----------->
11168515Sgshapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12168515Sgshapiro<PRE>
13132943Sgshapiro#include &lt;libmilter/mfapi.h&gt;
14132943Sgshapiroint smfi_quarantine(
15132943Sgshapiro	SMFICTX *ctx;
16132943Sgshapiro	char *reason;
17132943Sgshapiro);
18168515Sgshapiro</PRE>
19132943SgshapiroQuarantine the message using the given reason.
20168515Sgshapiro</TD></TR>
21132943Sgshapiro
22132943Sgshapiro<!----------- Description ---------->
23168515Sgshapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24168515Sgshapiro<TABLE border="1" cellspacing=1 cellpadding=4>
25168515Sgshapiro<TR align="left" valign=top>
26168515Sgshapiro<TH width="80">Called When</TH>
27168515Sgshapiro<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
28168515Sgshapiro</TR>
29168515Sgshapiro<TR align="left" valign=top>
30168515Sgshapiro<TH width="80">Effects</TH>
31168515Sgshapiro<TD>smfi_quarantine quarantines the message using the given reason.</TD>
32168515Sgshapiro</TR>
33168515Sgshapiro</TABLE>
34132943Sgshapiro
35132943Sgshapiro<!----------- Arguments ---------->
36168515Sgshapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37168515Sgshapiro    <TABLE border="1" cellspacing=0>
38168515Sgshapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39168515Sgshapiro    <TR valign="top"><TD>ctx</TD>
40168515Sgshapiro	<TD>Opaque context structure.
41168515Sgshapiro	</TD></TR>
42168515Sgshapiro    <TR valign="top"><TD>reason</TD>
43168515Sgshapiro	<TD>The quarantine reason, a non-NULL and non-empty null-terminated string.
44168515Sgshapiro	</TD></TR>
45168515Sgshapiro    </TABLE>
46168515Sgshapiro</TD></TR>
47132943Sgshapiro
48132943Sgshapiro<!----------- Return values ---------->
49168515Sgshapiro<TR>
50168515Sgshapiro<TH valign="top" align=left>RETURN VALUES</TH> 
51132943Sgshapiro
52168515Sgshapiro<TD>smfi_quarantine will fail and return MI_FAILURE if:
53168515Sgshapiro<UL>
54168515Sgshapiro    <LI>reason is NULL or empty.
55168515Sgshapiro    <LI>A network error occurs.
56168515Sgshapiro    <LI>SMFIF_QUARANTINE was not set when <A href="smfi_register.html">smfi_register</A> was called.
57168515Sgshapiro</UL>
58132943SgshapiroOtherwise, it will return MI_SUCCESS
59168515Sgshapiro</TD>
60168515Sgshapiro</TR>
61132943Sgshapiro
62168515Sgshapiro</TABLE>
63132943Sgshapiro
64168515Sgshapiro<HR size="1">
65168515Sgshapiro<FONT size="-1">
66132943SgshapiroCopyright (c) 2002-2003 Sendmail, Inc. and its suppliers.
67132943SgshapiroAll rights reserved.
68168515Sgshapiro<BR>
69132943SgshapiroBy using this file, you agree to the terms and conditions set
70132943Sgshapiroforth in the LICENSE.
71168515Sgshapiro</FONT>
72168515Sgshapiro</BODY>
73168515Sgshapiro</HTML>
74