1<HTML> 2<HEAD><TITLE>smfi_quarantine</TITLE></HEAD> 3<BODY> 4<!-- 5$Id: smfi_quarantine.html,v 1.5 2006/12/21 18:30:35 ca Exp $ 6--> 7<H1>smfi_quarantine</H1> 8 9<TABLE border="0" cellspacing=4 cellpadding=4> 10<!---------- Synopsis -----------> 11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> 12<PRE> 13#include <libmilter/mfapi.h> 14int smfi_quarantine( 15 SMFICTX *ctx; 16 char *reason; 17); 18</PRE> 19Quarantine the message using the given reason. 20</TD></TR> 21 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> 28</TR> 29<TR align="left" valign=top> 30<TH width="80">Effects</TH> 31<TD>smfi_quarantine quarantines the message using the given reason.</TD> 32</TR> 33</TABLE> 34 35<!----------- Arguments ----------> 36<TR><TH valign="top" align=left>ARGUMENTS</TH><TD> 37 <TABLE border="1" cellspacing=0> 38 <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR> 39 <TR valign="top"><TD>ctx</TD> 40 <TD>Opaque context structure. 41 </TD></TR> 42 <TR valign="top"><TD>reason</TD> 43 <TD>The quarantine reason, a non-NULL and non-empty null-terminated string. 44 </TD></TR> 45 </TABLE> 46</TD></TR> 47 48<!----------- Return values ----------> 49<TR> 50<TH valign="top" align=left>RETURN VALUES</TH> 51 52<TD>smfi_quarantine will fail and return MI_FAILURE if: 53<UL> 54 <LI>reason is NULL or empty. 55 <LI>A network error occurs. 56 <LI>SMFIF_QUARANTINE was not set when <A href="smfi_register.html">smfi_register</A> was called. 57</UL> 58Otherwise, it will return MI_SUCCESS 59</TD> 60</TR> 61 62</TABLE> 63 64<HR size="1"> 65<FONT size="-1"> 66Copyright (c) 2002-2003 Sendmail, Inc. and its suppliers. 67All rights reserved. 68<BR> 69By using this file, you agree to the terms and conditions set 70forth in the LICENSE. 71</FONT> 72</BODY> 73</HTML> 74