xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_header.html (revision e92d3f3ffe83a6ed7eaafac70da9cf4fafe13243)
1<html>
2<head><title>xxfi_header</title></head>
3<body>
4<!--
5$Id: xxfi_header.html,v 1.10 2003/03/05 19:57:55 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.  The
48  content of the header may include folded white space (i.e. multiple
49  lines with following white space).  The trailing line terminator (CR/LF)
50  is removed.
51	</td></tr>
52    </table>
53</td></tr>
54
55<!----------- Notes ---------->
56<tr>
57<th valign="top" align=left>NOTES</th>
58<td>
59<ul>
60<li>Later filters will see header changes/additions made by earlier ones.
61<li>For much more detail about header format, please see
62RFC <a href="http://www.rfc-editor.org/rfc/rfc822.html">822</a>
63</ul>
64</td>
65</tr>
66</table>
67
68<hr size="1">
69<font size="-1">
70Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
71All rights reserved.
72<br>
73By using this file, you agree to the terms and conditions set
74forth in the LICENSE.
75</font>
76</body>
77</html>
78