diff options
Diffstat (limited to 'contrib/sendmail/libmilter/docs/smfi_chgheader.html')
| -rw-r--r-- | contrib/sendmail/libmilter/docs/smfi_chgheader.html | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/contrib/sendmail/libmilter/docs/smfi_chgheader.html b/contrib/sendmail/libmilter/docs/smfi_chgheader.html new file mode 100644 index 0000000..4969674 --- /dev/null +++ b/contrib/sendmail/libmilter/docs/smfi_chgheader.html @@ -0,0 +1,96 @@ +<html> +<head><title>smfi_chgheader</title></head> +<body> +<h1>smfi_chgheader</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_chgheader( + SMFICTX *ctx, + char *headerf, + mi_int32 hdridx, + char *headerv +); +</pre> +Change or delete a message header. +</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>.</td> +</tr> +<tr align="left" valign=top> +<th width="80">Effects</th> +<td>Changes a header's value for the current message.</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>headerf</td> + <td>The header name, a non-NULL, null-terminated string. + </td></tr> + <tr valign="top"><td>hdridx</td> + <td>Header index value (1-based). A hdridx value of 1 will modify the first occurrence of a header named headerf. If hdridx is greater than the number of times headerf appears, a new copy of headerf will be added. + </td></tr> + <tr valign="top"><td>headerv</td> + <td>The new value of the given header. headerv == NULL implies that the header should be deleted. + </td></tr> + </table> +</td></tr> + +<!----------- Return values ----------> +<tr> +<th valign="top" align=left>RETURN VALUES</th> + +<td> +smfi_chgheader will return MI_FAILURE if +<ul><li>headerf is NULL + <li>Modifying headers in the current connection state is invalid. + <li>Memory allocation fails. + <li>A network error occurs. + <li>SMFIF_CHGHDRS was not set when <a href="smfi_register.html">smfi_register</a> was called. +</ul> +Otherwise, it returns MI_SUCCESS. +</tr> + +<!----------- Notes ----------> +<tr align="left" valign=top> +<th>NOTES</th> +<td> +<ul><li>While smfi_chgheader may be used to add new headers, it is more efficient and far safer to use <a href="smfi_addheader.html">smfi_addheader</a>. + <li>A filter which calls smfi_chgheader must have set the SMFIF_CHGHDRS flag in the smfiDesc_str passed to <a href="smfi_register.html">smfi_register</a>. + <li>For smfi_chgheader, filter order is important. <b>Later filters will see the header changes made by earlier ones.</b> + <li>Neither the name nor the value of the header is checked for + standards compliance. However, each line of the header must be under + 2048 characters and should be under 998 characters. If longer headers + are needed, make them multiline. + <b>It is the filter writer's responsibility to ensure that no standards + are violated.</b> +</ul> +</td> +</tr> + +</table> + +<hr size="1"> +<font size="-1"> +Copyright (c) 2000-2001 Sendmail, Inc. and its suppliers. +All rights reserved. +<br> +By using this file, you agree to the terms and conditions set +forth in the <a href="LICENSE.txt">LICENSE</a>. +</font> +</body> +</html> |
