freebsd-dev/contrib/sendmail/libmilter/docs/xxfi_header.html
2003-03-29 19:12:53 +00:00

75 lines
1.9 KiB
HTML

<html>
<head><title>xxfi_header</title></head>
<body>
<h1>xxfi_header</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;
sfsistat (*xxfi_header)(
SMFICTX * ctx,
char * headerf,
char * headerv
);
</pre>
Handle 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>xxfi_header is called zero or more times between xxfi_envrcpt and xxfi_eoh, once per message header.</td>
</tr>
<tr align="left" valign=top>
<th>Default Behavior</th>
<td>Do nothing; return SMFIS_CONTINUE.</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> Header field name.
</td></tr>
<tr valign="top"><td>headerv</td>
<td>Header field value. The
content of the header may include folded white space (i.e. multiple
lines with following white space). The trailing line terminator (CR/LF)
is removed.
</td></tr>
</table>
</td></tr>
<!----------- Notes ---------->
<tr>
<th valign="top" align=left>NOTES</th>
<td>
<ul>
<li>Later filters will see header changes/additions made by earlier ones.
<li>For much more detail about header format, please see
RFC <a href="http://www.rfc-editor.org/rfc/rfc822.html">822</a>
</ul>
</td>
</tr>
</table>
<hr size="1">
<font size="-1">
Copyright (c) 2000, 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>