smfi_quarantine.html revision 168516 
1212700Sjkim<HTML>
2212700Sjkim<HEAD><TITLE>smfi_quarantine</TITLE></HEAD>
3212700Sjkim<BODY>
4212700Sjkim<!--
5212700Sjkim$Id: smfi_quarantine.html,v 1.5 2006/12/21 18:30:35 ca Exp $
6212700Sjkim-->
7212700Sjkim<H1>smfi_quarantine</H1>
8212700Sjkim
9212700Sjkim<TABLE border="0" cellspacing=4 cellpadding=4>
10212700Sjkim<!---------- Synopsis ----------->
11212700Sjkim<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12212700Sjkim<PRE>
13212700Sjkim#include &lt;libmilter/mfapi.h&gt;
14212700Sjkimint smfi_quarantine(
15212700Sjkim	SMFICTX *ctx;
16212700Sjkim	char *reason;
17212700Sjkim);
18212700Sjkim</PRE>
19212700SjkimQuarantine the message using the given reason.
20212700Sjkim</TD></TR>
21212700Sjkim
22212700Sjkim<!----------- Description ---------->
23212700Sjkim<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24212700Sjkim<TABLE border="1" cellspacing=1 cellpadding=4>
25212700Sjkim<TR align="left" valign=top>
26212700Sjkim<TH width="80">Called When</TH>
27212700Sjkim<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
28212700Sjkim</TR>
29212700Sjkim<TR align="left" valign=top>
30212700Sjkim<TH width="80">Effects</TH>
31212700Sjkim<TD>smfi_quarantine quarantines the message using the given reason.</TD>
32212700Sjkim</TR>
33212700Sjkim</TABLE>
34212700Sjkim
35212700Sjkim<!----------- Arguments ---------->
36212700Sjkim<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37212700Sjkim    <TABLE border="1" cellspacing=0>
38212700Sjkim    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39212700Sjkim    <TR valign="top"><TD>ctx</TD>
40212700Sjkim	<TD>Opaque context structure.
41212700Sjkim	</TD></TR>
42212700Sjkim    <TR valign="top"><TD>reason</TD>
43212700Sjkim	<TD>The quarantine reason, a non-NULL and non-empty null-terminated string.
44212700Sjkim	</TD></TR>
45212700Sjkim    </TABLE>
46212700Sjkim</TD></TR>
47212700Sjkim
48212700Sjkim<!----------- Return values ---------->
49212700Sjkim<TR>
50212700Sjkim<TH valign="top" align=left>RETURN VALUES</TH> 
51212700Sjkim
52212700Sjkim<TD>smfi_quarantine will fail and return MI_FAILURE if:
53212700Sjkim<UL>
54212700Sjkim    <LI>reason is NULL or empty.
55212700Sjkim    <LI>A network error occurs.
56212700Sjkim    <LI>SMFIF_QUARANTINE was not set when <A href="smfi_register.html">smfi_register</A> was called.
57212700Sjkim</UL>
58212700SjkimOtherwise, it will return MI_SUCCESS
59212700Sjkim</TD>
60212700Sjkim</TR>
61212700Sjkim
62212700Sjkim</TABLE>
63212700Sjkim
64212700Sjkim<HR size="1">
65212700Sjkim<FONT size="-1">
66212700SjkimCopyright (c) 2002-2003 Sendmail, Inc. and its suppliers.
67212700SjkimAll rights reserved.
68212700Sjkim<BR>
69212700SjkimBy using this file, you agree to the terms and conditions set
70212700Sjkimforth in the LICENSE.
71212700Sjkim</FONT>
72212700Sjkim</BODY>
73212700Sjkim</HTML>
74212700Sjkim