2 <HEAD><TITLE>smfi_quarantine</TITLE></HEAD>
5 $Id: smfi_quarantine.html,v 1.6 2013-11-22 20:51:39 ca Exp $
7 <H1>smfi_quarantine</H1>
9 <TABLE border="0" cellspacing=4 cellpadding=4>
10 <!---------- Synopsis ----------->
11 <TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
13 #include <libmilter/mfapi.h>
19 Quarantine the message using the given reason.
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>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
29 <TR align="left" valign=top>
30 <TH width="80">Effects</TH>
31 <TD>smfi_quarantine quarantines the message using the given reason.</TD>
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.
43 <TR valign="top"><TD>reason</TD>
44 <TD>The quarantine reason, a non-NULL and non-empty null-terminated string.
49 <!----------- Return values ---------->
51 <TH valign="top" align=left>RETURN VALUES</TH>
53 <TD>smfi_quarantine will fail and return MI_FAILURE if:
55 <LI>reason is NULL or empty.
56 <LI>A network error occurs.
57 <LI><A HREF="smfi_register.html#SMFIF_QUARANTINE">SMFIF_QUARANTINE</A> is not set.
59 Otherwise, it will return MI_SUCCESS
67 Copyright (c) 2002-2003 Proofpoint, Inc. and its suppliers.
70 By using this file, you agree to the terms and conditions set