contrib/sendmail-8.13.4/libmilter/docs/smfi_quarantine.html

   1 <html>
   2 <head><title>smfi_quarantine</title></head>
   3 <body>
   4 <!--
   5 $Id: smfi_quarantine.html,v 1.3 2003/03/05 19:57:54 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=150>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
  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>
  58 Otherwise, it will return MI_SUCCESS
  59 </td>
  60 </tr>
  61
  62 </table>
  63
  64 <hr size="1">
  65 <font size="-1">
  66 Copyright (c) 2002-2003 Sendmail, Inc. and its suppliers.
  67 All rights reserved.
  68 <br>
  69 By using this file, you agree to the terms and conditions set
  70 forth in the LICENSE.
  71 </font>
  72 </body>
  73 </html>