opnsense-src/contrib/sendmail/libmilter/docs/smfi_progress.html

69 lines
1.6 KiB
HTML
Raw Normal View History

2007-04-08 21:38:51 -04:00
<HTML>
<HEAD><TITLE>smfi_progress</TITLE></HEAD>
<BODY>
2004-07-31 21:04:57 -04:00
<!--
2007-04-08 21:38:51 -04:00
$Id: smfi_progress.html,v 1.5 2006/12/21 18:30:35 ca Exp $
2004-07-31 21:04:57 -04:00
-->
2007-04-08 21:38:51 -04:00
<H1>smfi_progress</H1>
2004-07-31 21:04:57 -04:00
2007-04-08 21:38:51 -04:00
<TABLE border="0" cellspacing=4 cellpadding=4>
2004-07-31 21:04:57 -04:00
<!---------- Synopsis ----------->
2007-04-08 21:38:51 -04:00
<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
<PRE>
2004-07-31 21:04:57 -04:00
#include &lt;libmilter/mfapi.h&gt;
int smfi_progress(
SMFICTX *ctx;
);
2007-04-08 21:38:51 -04:00
</PRE>
2004-07-31 21:04:57 -04:00
Notify the MTA that an operation is still in progress.
2007-04-08 21:38:51 -04:00
</TD></TR>
2004-07-31 21:04:57 -04:00
<!----------- Description ---------->
2007-04-08 21:38:51 -04:00
<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
<TABLE border="1" cellspacing=1 cellpadding=4>
<TR align="left" valign=top>
<TH width="80">Called When</TH>
<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD>
</TR>
<TR align="left" valign=top>
<TH width="80">Effects</TH>
<TD>smfi_progress notifies the MTA that the filter is still working
on a message, causing the MTA to re-start its timeouts.</TD>
</TR>
</TABLE>
2004-07-31 21:04:57 -04:00
<!----------- Arguments ---------->
2007-04-08 21:38:51 -04:00
<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
<TABLE border="1" cellspacing=0>
<TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
<TR valign="top"><TD>ctx</TD>
<TD>Opaque context structure.
</TD></TR>
</TABLE>
</TD></TR>
2004-07-31 21:04:57 -04:00
<!----------- Return values ---------->
2007-04-08 21:38:51 -04:00
<TR>
<TH valign="top" align=left>RETURN VALUES</TH>
2004-07-31 21:04:57 -04:00
2007-04-08 21:38:51 -04:00
<TD>smfi_progress will fail and return MI_FAILURE if:
<UL>
<LI>A network error occurs.
</UL>
2004-07-31 21:04:57 -04:00
Otherwise, it will return MI_SUCCESS
2007-04-08 21:38:51 -04:00
</TD>
</TR>
2004-07-31 21:04:57 -04:00
2007-04-08 21:38:51 -04:00
</TABLE>
2004-07-31 21:04:57 -04:00
2007-04-08 21:38:51 -04:00
<HR size="1">
<FONT size="-1">
2004-07-31 21:04:57 -04:00
Copyright (c) 2003 Sendmail, Inc. and its suppliers.
All rights reserved.
2007-04-08 21:38:51 -04:00
<BR>
2004-07-31 21:04:57 -04:00
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
2007-04-08 21:38:51 -04:00
</FONT>
</BODY>
</HTML>