xxfi_header.html revision 159609 
1<html>
2<head><title>xxfi_header</title></head>
3<body>
4<!--
5$Id: xxfi_header.html,v 1.11 2006/04/05 17:10:43 ca Exp $
6-->
7<h1>xxfi_header</h1>
8
9<table border="0" cellspacing=4 cellpadding=4>
10<!---------- Synopsis ----------->
11<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12<pre>
13#include &lt;libmilter/mfapi.h&gt;
14sfsistat (*xxfi_header)(
15	SMFICTX * ctx,
16	char * headerf,
17	char * headerv
18);
19</pre>
20Handle a message header.
21</td></tr>
22
23<!----------- Description ---------->
24<tr><th valign="top" align=left>DESCRIPTION</th><td>
25<table border="1" cellspacing=1 cellpadding=4>
26<tr align="left" valign=top>
27<th width="80">Called When</th>
28<td>xxfi_header is called zero or more times between xxfi_envrcpt and xxfi_eoh, once per message header.</td>
29</tr>
30<tr align="left" valign=top>
31<th>Default Behavior</th>
32<td>Do nothing; return SMFIS_CONTINUE.</td>
33</tr>
34</table>
35
36<!----------- Arguments ---------->
37<tr><th valign="top" align=left>ARGUMENTS</th><td>
38    <table border="1" cellspacing=0>
39    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
40    <tr valign="top"><td>ctx</td>
41	<td>Opaque context structure.
42	</td></tr>
43    <tr valign="top"><td>headerf</td>
44	<td> Header field name.
45	</td></tr>
46    <tr valign="top"><td>headerv</td>
47	<td>Header field value.
48	The content of the header may include folded white space,
49	i.e., multiple lines with following white space
50	where lines are separated by LF (not CR/LF).
51	The trailing line terminator (CR/LF) is removed.
52	</td></tr>
53    </table>
54</td></tr>
55
56<!----------- Notes ---------->
57<tr>
58<th valign="top" align=left>NOTES</th> 
59<td>
60<ul>
61<li>Later filters will see header changes/additions made by earlier ones.
62<li>For much more detail about header format, please see 
63RFC <a href="http://www.rfc-editor.org/rfc/rfc822.html">822</a>
64</ul>
65</td>
66</tr>
67</table>
68
69<hr size="1">
70<font size="-1">
71Copyright (c) 2000, 2003, 2006 Sendmail, Inc. and its suppliers.
72All rights reserved.
73<br>
74By using this file, you agree to the terms and conditions set
75forth in the LICENSE.
76</font>
77</body>
78</html>
79