1<HTML> 2<HEAD><TITLE>smfi_quarantine</TITLE></HEAD> 3<BODY>
| 1<html> 2<head><title>smfi_quarantine</title></head> 3<body>
|
4<!--
| 4<!--
|
5$Id: smfi_quarantine.html,v 1.6 2013-11-22 20:51:39 ca Exp $
| 5$Id: smfi_quarantine.html,v 1.3 2003/03/05 19:57:54 ca Exp $
|
6-->
| 6-->
|
7<H1>smfi_quarantine</H1>
| 7<h1>smfi_quarantine</h1>
|
8
| 8
|
9<TABLE border="0" cellspacing=4 cellpadding=4>
| 9<table border="0" cellspacing=4 cellpadding=4>
|
10<!---------- Synopsis ----------->
| 10<!---------- Synopsis ----------->
|
11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> 12<PRE>
| 11<tr><th valign="top" align=left width=150>SYNOPSIS</th><td> 12<pre>
|
13#include <libmilter/mfapi.h> 14int smfi_quarantine( 15 SMFICTX *ctx; 16 char *reason; 17);
| 13#include <libmilter/mfapi.h> 14int smfi_quarantine( 15 SMFICTX *ctx; 16 char *reason; 17);
|
18</PRE>
| 18</pre>
|
19Quarantine the message using the given reason.
| 19Quarantine the message using the given reason.
|
20</TD></TR>
| 20</td></tr>
|
21 22<!----------- Description ---------->
| 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>
| 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 ---------->
| 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>
| 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 ---------->
| 47 48<!----------- Return values ---------->
|
49<TR> 50<TH valign="top" align=left>RETURN VALUES</TH>
| 49<tr> 50<th valign="top" align=left>RETURN VALUES</th>
|
51
| 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>
| 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
| 58Otherwise, it will return MI_SUCCESS
|
59</TD> 60</TR>
| 59</td> 60</tr>
|
61
| 61
|
62</TABLE>
| 62</table>
|
63
| 63
|
64<HR size="1"> 65<FONT size="-1"> 66Copyright (c) 2002-2003 Proofpoint, Inc. and its suppliers.
| 64<hr size="1"> 65<font size="-1"> 66Copyright (c) 2002-2003 Sendmail, Inc. and its suppliers.
|
67All rights reserved.
| 67All rights reserved.
|
68<BR>
| 68<br>
|
69By using this file, you agree to the terms and conditions set 70forth in the LICENSE.
| 69By using this file, you agree to the terms and conditions set 70forth in the LICENSE.
|
71</FONT> 72</BODY> 73</HTML>
| 71</font> 72</body> 73</html>
|
| |