xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_header.html (revision af9557fdd1de47bcfff61cccba2930e93ec4e69b)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>xxfi_header</title></head>
340266059SGregory Neil Shapiro<body>
4e92d3f3fSGregory Neil Shapiro<!--
5af9557fdSGregory Neil Shapiro$Id: xxfi_header.html,v 1.11 2006/04/05 17:10:43 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
740266059SGregory Neil Shapiro<h1>xxfi_header</h1>
840266059SGregory Neil Shapiro
940266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
1140266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
1240266059SGregory Neil Shapiro<pre>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapirosfsistat (*xxfi_header)(
1540266059SGregory Neil Shapiro	SMFICTX * ctx,
1640266059SGregory Neil Shapiro	char * headerf,
1740266059SGregory Neil Shapiro	char * headerv
1840266059SGregory Neil Shapiro);
1940266059SGregory Neil Shapiro</pre>
2040266059SGregory Neil ShapiroHandle a message header.
2140266059SGregory Neil Shapiro</td></tr>
2240266059SGregory Neil Shapiro
2340266059SGregory Neil Shapiro<!----------- Description ---------->
2440266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
2540266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2640266059SGregory Neil Shapiro<tr align="left" valign=top>
2740266059SGregory Neil Shapiro<th width="80">Called When</th>
2840266059SGregory Neil Shapiro<td>xxfi_header is called zero or more times between xxfi_envrcpt and xxfi_eoh, once per message header.</td>
2940266059SGregory Neil Shapiro</tr>
3040266059SGregory Neil Shapiro<tr align="left" valign=top>
3140266059SGregory Neil Shapiro<th>Default Behavior</th>
3240266059SGregory Neil Shapiro<td>Do nothing; return SMFIS_CONTINUE.</td>
3340266059SGregory Neil Shapiro</tr>
3440266059SGregory Neil Shapiro</table>
3540266059SGregory Neil Shapiro
3640266059SGregory Neil Shapiro<!----------- Arguments ---------->
3740266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
3840266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
3940266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
4040266059SGregory Neil Shapiro    <tr valign="top"><td>ctx</td>
4140266059SGregory Neil Shapiro	<td>Opaque context structure.
4240266059SGregory Neil Shapiro	</td></tr>
4340266059SGregory Neil Shapiro    <tr valign="top"><td>headerf</td>
4440266059SGregory Neil Shapiro	<td> Header field name.
4540266059SGregory Neil Shapiro	</td></tr>
4640266059SGregory Neil Shapiro    <tr valign="top"><td>headerv</td>
47af9557fdSGregory Neil Shapiro	<td>Header field value.
48af9557fdSGregory Neil Shapiro	The content of the header may include folded white space,
49af9557fdSGregory Neil Shapiro	i.e., multiple lines with following white space
50af9557fdSGregory Neil Shapiro	where lines are separated by LF (not CR/LF).
51af9557fdSGregory Neil Shapiro	The trailing line terminator (CR/LF) is removed.
5240266059SGregory Neil Shapiro	</td></tr>
5340266059SGregory Neil Shapiro    </table>
5440266059SGregory Neil Shapiro</td></tr>
5540266059SGregory Neil Shapiro
5640266059SGregory Neil Shapiro<!----------- Notes ---------->
5740266059SGregory Neil Shapiro<tr>
5840266059SGregory Neil Shapiro<th valign="top" align=left>NOTES</th>
5940266059SGregory Neil Shapiro<td>
6040266059SGregory Neil Shapiro<ul>
6140266059SGregory Neil Shapiro<li>Later filters will see header changes/additions made by earlier ones.
6240266059SGregory Neil Shapiro<li>For much more detail about header format, please see
635ef517c0SGregory Neil ShapiroRFC <a href="http://www.rfc-editor.org/rfc/rfc822.html">822</a>
6440266059SGregory Neil Shapiro</ul>
6540266059SGregory Neil Shapiro</td>
6640266059SGregory Neil Shapiro</tr>
6740266059SGregory Neil Shapiro</table>
6840266059SGregory Neil Shapiro
6940266059SGregory Neil Shapiro<hr size="1">
7040266059SGregory Neil Shapiro<font size="-1">
71af9557fdSGregory Neil ShapiroCopyright (c) 2000, 2003, 2006 Sendmail, Inc. and its suppliers.
7240266059SGregory Neil ShapiroAll rights reserved.
7340266059SGregory Neil Shapiro<br>
7440266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
755ef517c0SGregory Neil Shapiroforth in the LICENSE.
7640266059SGregory Neil Shapiro</font>
7740266059SGregory Neil Shapiro</body>
7840266059SGregory Neil Shapiro</html>
79