diff options
Diffstat (limited to 'contrib/sendmail/libmilter/docs/smfi_insheader.html')
| -rw-r--r-- | contrib/sendmail/libmilter/docs/smfi_insheader.html | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/contrib/sendmail/libmilter/docs/smfi_insheader.html b/contrib/sendmail/libmilter/docs/smfi_insheader.html new file mode 100644 index 0000000..837a1fd --- /dev/null +++ b/contrib/sendmail/libmilter/docs/smfi_insheader.html @@ -0,0 +1,123 @@ +<html> +<head><title>smfi_insheader</title></head> +<body> +<!-- +$Id: smfi_insheader.html,v 1.3 2004/05/04 16:20:34 gshapiro Exp $ +--> +<h1>smfi_insheader</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_insheader( + SMFICTX *ctx, + int hdridx, + char *headerf, + char *headerv +); +</pre> +Prepend a header to the current message. +</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>Prepends a header to 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>hdridx</td> + <td>The location in the internal header list where this header should + be inserted; 0 makes it the topmost header, etc. + </td></tr> + <tr valign="top"><td>headerf</td> + <td>The header name, a non-NULL, null-terminated string. + </td></tr> + <tr valign="top"><td>headerv</td> + <td>The header value to be added, a non-NULL, null-terminated string. This may be the empty string. + </td></tr> + </table> +</td></tr> + +<!----------- Return values ----------> +<tr> +<th valign="top" align=left>RETURN VALUES</th> + +<td>smfi_insheader returns MI_FAILURE if: +<ul><li>headerf or headerv is NULL. + <li>Adding headers in the current connection state is invalid. + <li>Memory allocation fails. + <li>A network error occurs. + <li>SMFIF_ADDHDRS was not set when <a href="smfi_register.html">smfi_register</a> was called. +</ul> +Otherwise, it returns MI_SUCCESS. +</td> +</tr> + +<!----------- Notes ----------> +<tr align="left" valign=top> +<th>NOTES</th> +<td> +<ul><li>smfi_insheader does not change a message's existing headers. +To change a header's current value, use <a +href="smfi_chgheader.html">smfi_chgheader</a>. + <li>A filter which calls smfi_insheader must have set the SMFIF_ADDHDRS flag in the smfiDesc_str passed to <a href="smfi_register.html">smfi_register</a>. + <li>For smfi_insheader, filter order is important. <b>Later filters will see the header changes made by earlier ones.</b> + <li>If hdridx is a number larger than the number of headers in the message, the header will simply be appended. + <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 multi-line. To make a multi-line header, insert + a line feed (ASCII 0x0a, or <tt>\n</tt> in C) followed by at least + one whitespace character such as a space (ASCII 0x20) or tab (ASCII 0x09, + or <tt>\t</tt> in C). The line feed should NOT be preceded by a + carriage return (ASCII 0x0d); the MTA will add this automatically. + <b>It is the filter writer's responsibility to ensure that no standards + are violated.</b> +</ul> +</td> +</tr> + +<!----------- Example code ----------> +<tr> +<th valign="top" align=left>EXAMPLE</th> + +<td> + <pre> + int ret; + SMFICTX *ctx; + + ... + + ret = smfi_insheader(ctx, 0, "First", "See me?"); + </pre> +</td> +</tr> + +</table> + +<hr size="1"> +<font size="-1"> +Copyright (c) 2004 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> |
