2 <head><title>smfi_quarantine</title></head>
5 $Id: smfi_quarantine.html,v 1.3 2003/03/05 19:57:54 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=150>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>
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.
42 <tr valign="top"><td>reason</td>
43 <td>The quarantine reason, a non-NULL and non-empty null-terminated string.
48 <!----------- Return values ---------->
50 <th valign="top" align=left>RETURN VALUES</th>
52 <td>smfi_quarantine will fail and return MI_FAILURE if:
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.
58 Otherwise, it will return MI_SUCCESS
66 Copyright (c) 2002-2003 Sendmail, Inc. and its suppliers.
69 By using this file, you agree to the terms and conditions set