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

<html>
<head><title>smfi_replacebody</title></head>
<body>
<h1>smfi_replacebody</h1>

<table border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
<pre>
#include &lt;libmilter/mfapi.h&gt;
int smfi_replacebody(
	SMFICTX *ctx,
	unsigned char *bodyp,
	int bodylen
);
</pre>
Replace message-body data.
</td></tr>

<!----------- Description ---------->
<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>.  smfi_replacebody may be called more than once.</td>
</tr>
<tr align="left" valign=top>
<th width="80">Effects</th>
<td>smfi_replacebody replaces the body of the current message.  If called 
more than once, subsequent calls result in data being appended to the new 
body.
</td>
</tr>
</table>

<!----------- Arguments ---------->
<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>
    <tr valign="top"><td>bodyp</td>
	<td>A pointer to the start of the new body data, which does not have to be null-terminated.  If bodyp is NULL, it is treated as having length == 0.  Body data should be in CR/LF form.
	</td></tr>
    <tr valign="top"><td>bodylen</td>
	<td>The number of data bytes pointed to by bodyp.
	</td></tr>
    </table>
</td></tr>

<!----------- Return values ---------->
<tr>
<th valign="top" align=left>RETURN VALUES</th> 

<td>smfi_replacebody fails and returns MI_FAILURE if:
<ul>
    <li>bodyp == NULL and bodylen &gt; 0.
    <li>Changing the body in the current connection state is invalid.
    <li>A network error occurs.
    <li>SMFIF_CHGBODY was not set when <a href="smfi_register.html">smfi_register</a> was called.
</ul>
Otherwise, it will return MI_SUCCESS.
</td>
</tr>

<!----------- Notes ---------->
<tr align="left" valign=top>
<th>NOTES</th> 
<td>
<ul>
    <li>Since the message body may be very large, setting SMFIF_CHGBODY may significantly affect filter performance.
    <li>If a filter sets SMFIF_CHGBODY but does not call smfi_replacebody, the original body remains unchanged.
    <li>For smfi_replacebody, filter order is important.  <b>Later filters will see the new body contents created by earlier ones.</b>
</ul>
</td>
</tr>

</table>

<hr size="1">
<font size="-1">
Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the LICENSE.
</font>
</body>
</html>
Import sendmail 8.12.2 2002-02-17 16:56:45 -05:00			`<html>`
			`<head><title>smfi_replacebody</title></head>`
			`<body>`
			`<h1>smfi_replacebody</h1>`

			`<table border="0" cellspacing=4 cellpadding=4>`
			`<!---------- Synopsis ----------->`
			`<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>`
			`<pre>`
			`#include <libmilter/mfapi.h>`
			`int smfi_replacebody(`
			`SMFICTX *ctx,`
			`unsigned char *bodyp,`
			`int bodylen`
			`);`
			`</pre>`
			`Replace message-body data.`
			`</td></tr>`

			`<!----------- Description ---------->`
			`<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>. smfi_replacebody may be called more than once.</td>`
			`</tr>`
			`<tr align="left" valign=top>`
			`<th width="80">Effects</th>`
			`<td>smfi_replacebody replaces the body of the current message. If called`
			`more than once, subsequent calls result in data being appended to the new`
			`body.`
			`</td>`
			`</tr>`
			`</table>`

			`<!----------- Arguments ---------->`
			`<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>`
			`<tr valign="top"><td>bodyp</td>`
			`<td>A pointer to the start of the new body data, which does not have to be null-terminated. If bodyp is NULL, it is treated as having length == 0. Body data should be in CR/LF form.`
			`</td></tr>`
			`<tr valign="top"><td>bodylen</td>`
			`<td>The number of data bytes pointed to by bodyp.`
			`</td></tr>`
			`</table>`
			`</td></tr>`

			`<!----------- Return values ---------->`
			`<tr>`
			`<th valign="top" align=left>RETURN VALUES</th>`

			`<td>smfi_replacebody fails and returns MI_FAILURE if:`
			`<ul>`
			`<li>bodyp == NULL and bodylen > 0.`
			`<li>Changing the body in the current connection state is invalid.`
			`<li>A network error occurs.`
			`<li>SMFIF_CHGBODY was not set when <a href="smfi_register.html">smfi_register</a> was called.`
			`</ul>`
			`Otherwise, it will return MI_SUCCESS.`
			`</td>`
			`</tr>`

			`<!----------- Notes ---------->`
			`<tr align="left" valign=top>`
			`<th>NOTES</th>`
			`<td>`
			`<ul>`
			`<li>Since the message body may be very large, setting SMFIF_CHGBODY may significantly affect filter performance.`
			`<li>If a filter sets SMFIF_CHGBODY but does not call smfi_replacebody, the original body remains unchanged.`
			`<li>For smfi_replacebody, filter order is important. <b>Later filters will see the new body contents created by earlier ones.</b>`
			`</ul>`
			`</td>`
			`</tr>`

			`</table>`

			`<hr size="1">`
			`<font size="-1">`
Import sendmail 8.12.9 2003-03-29 14:12:53 -05:00			`Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.`
Import sendmail 8.12.2 2002-02-17 16:56:45 -05:00			`All rights reserved.`
			`<br>`
			`By using this file, you agree to the terms and conditions set`
Import sendmail 8.12.9 2003-03-29 14:12:53 -05:00			`forth in the LICENSE.`
Import sendmail 8.12.2 2002-02-17 16:56:45 -05:00			`</font>`
			`</body>`
			`</html>`