xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_quarantine.html (revision e2c0e292e8a7ca00ba99bcfccc9e637f45c3e8b1)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_quarantine</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
54313cc83SGregory Neil Shapiro$Id: smfi_quarantine.html,v 1.6 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_quarantine</H1>
8e92d3f3fSGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
10e92d3f3fSGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
13e92d3f3fSGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
14e92d3f3fSGregory Neil Shapiroint smfi_quarantine(
15e92d3f3fSGregory Neil Shapiro	SMFICTX *ctx;
16e92d3f3fSGregory Neil Shapiro	char *reason;
17e92d3f3fSGregory Neil Shapiro);
18d0cef73dSGregory Neil Shapiro</PRE>
19e92d3f3fSGregory Neil ShapiroQuarantine the message using the given reason.
20d0cef73dSGregory Neil Shapiro</TD></TR>
21e92d3f3fSGregory Neil Shapiro
22e92d3f3fSGregory Neil Shapiro<!----------- Description ---------->
23d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
25d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
26d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
27d0cef73dSGregory Neil Shapiro<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
28d0cef73dSGregory Neil Shapiro</TR>
29d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
30d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
31d0cef73dSGregory Neil Shapiro<TD>smfi_quarantine quarantines the message using the given reason.</TD>
32d0cef73dSGregory Neil Shapiro</TR>
33d0cef73dSGregory Neil Shapiro</TABLE>
34*5b0945b5SGregory Neil Shapiro</TD></TR>
35e92d3f3fSGregory Neil Shapiro
36e92d3f3fSGregory Neil Shapiro<!----------- Arguments ---------->
37d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
39d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
41d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
42d0cef73dSGregory Neil Shapiro	</TD></TR>
43d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>reason</TD>
44d0cef73dSGregory Neil Shapiro	<TD>The quarantine reason, a non-NULL and non-empty null-terminated string.
45d0cef73dSGregory Neil Shapiro	</TD></TR>
46d0cef73dSGregory Neil Shapiro    </TABLE>
47d0cef73dSGregory Neil Shapiro</TD></TR>
48e92d3f3fSGregory Neil Shapiro
49e92d3f3fSGregory Neil Shapiro<!----------- Return values ---------->
50d0cef73dSGregory Neil Shapiro<TR>
51d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
52e92d3f3fSGregory Neil Shapiro
53d0cef73dSGregory Neil Shapiro<TD>smfi_quarantine will fail and return MI_FAILURE if:
54d0cef73dSGregory Neil Shapiro<UL>
55d0cef73dSGregory Neil Shapiro    <LI>reason is NULL or empty.
56d0cef73dSGregory Neil Shapiro    <LI>A network error occurs.
57*5b0945b5SGregory Neil Shapiro    <LI><A HREF="smfi_register.html#SMFIF_QUARANTINE">SMFIF_QUARANTINE</A> is not set.
58d0cef73dSGregory Neil Shapiro</UL>
59e92d3f3fSGregory Neil ShapiroOtherwise, it will return MI_SUCCESS
60d0cef73dSGregory Neil Shapiro</TD>
61d0cef73dSGregory Neil Shapiro</TR>
62e92d3f3fSGregory Neil Shapiro
63d0cef73dSGregory Neil Shapiro</TABLE>
64e92d3f3fSGregory Neil Shapiro
65d0cef73dSGregory Neil Shapiro<HR size="1">
66d0cef73dSGregory Neil Shapiro<FONT size="-1">
675dd76dd0SGregory Neil ShapiroCopyright (c) 2002-2003 Proofpoint, Inc. and its suppliers.
68e92d3f3fSGregory Neil ShapiroAll rights reserved.
69d0cef73dSGregory Neil Shapiro<BR>
70e92d3f3fSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
71e92d3f3fSGregory Neil Shapiroforth in the LICENSE.
72d0cef73dSGregory Neil Shapiro</FONT>
73d0cef73dSGregory Neil Shapiro</BODY>
74d0cef73dSGregory Neil Shapiro</HTML>
75