contrib/sendmail/libmilter/docs/smfi_quarantine.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_quarantine</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_quarantine.html,v 1.6 2013-11-22 20:51:39 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 &lt;libmilter/mfapi.h&gt;
  14 int smfi_quarantine(
  15         SMFICTX *ctx;
  16         char *reason;
  17 );
  18 </PRE>
  19 Quarantine 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 </TD></TR>
  35
  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.
  42         </TD></TR>
  43     <TR valign="top"><TD>reason</TD>
  44         <TD>The quarantine reason, a non-NULL and non-empty null-terminated string.
  45         </TD></TR>
  46     </TABLE>
  47 </TD></TR>
  48
  49 <!----------- Return values ---------->
  50 <TR>
  51 <TH valign="top" align=left>RETURN VALUES</TH>
  52
  53 <TD>smfi_quarantine will fail and return MI_FAILURE if:
  54 <UL>
  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.
  58 </UL>
  59 Otherwise, it will return MI_SUCCESS
  60 </TD>
  61 </TR>
  62
  63 </TABLE>
  64
  65 <HR size="1">
  66 <FONT size="-1">
  67 Copyright (c) 2002-2003 Proofpoint, Inc. and its suppliers.
  68 All rights reserved.
  69 <BR>
  70 By using this file, you agree to the terms and conditions set
  71 forth in the LICENSE.
  72 </FONT>
  73 </BODY>
  74 </HTML>