xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_header.html (revision d0cef73d40a409e3116f095b83633b1364e95741)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>xxfi_header</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
5d0cef73dSGregory Neil Shapiro$Id: xxfi_header.html,v 1.17 2006/12/21 18:30:36 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>xxfi_header</H1>
840266059SGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory 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);
19d0cef73dSGregory Neil Shapiro</PRE>
2040266059SGregory Neil ShapiroHandle a message header.
21d0cef73dSGregory Neil Shapiro</TD></TR>
2240266059SGregory Neil Shapiro
2340266059SGregory Neil Shapiro<!----------- Description ---------->
24d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
25d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
26d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
27d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
28d0cef73dSGregory Neil Shapiro<TD>xxfi_header is called once for each message header.</TD>
29d0cef73dSGregory Neil Shapiro</TR>
30d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
31d0cef73dSGregory Neil Shapiro<TH>Default Behavior</TH>
32d0cef73dSGregory Neil Shapiro<TD>Do nothing; return SMFIS_CONTINUE.</TD>
33d0cef73dSGregory Neil Shapiro</TR>
34d0cef73dSGregory Neil Shapiro</TABLE>
3540266059SGregory Neil Shapiro
3640266059SGregory Neil Shapiro<!----------- Arguments ---------->
37d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
39d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
41d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
42d0cef73dSGregory Neil Shapiro	</TD></TR>
43d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>headerf</TD>
44d0cef73dSGregory Neil Shapiro	<TD> Header field name.
45d0cef73dSGregory Neil Shapiro	</TD></TR>
46d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>headerv</TD>
47d0cef73dSGregory 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.
52d0cef73dSGregory Neil Shapiro	</TD></TR>
53d0cef73dSGregory Neil Shapiro    </TABLE>
54d0cef73dSGregory Neil Shapiro</TD></TR>
5540266059SGregory Neil Shapiro
5640266059SGregory Neil Shapiro<!----------- Notes ---------->
57d0cef73dSGregory Neil Shapiro<TR>
58d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>NOTES</TH>
59d0cef73dSGregory Neil Shapiro<TD>
60d0cef73dSGregory Neil Shapiro<UL>
61d0cef73dSGregory Neil Shapiro<LI>Starting with sendmail 8.14, spaces after the colon in a header
62d0cef73dSGregory Neil Shapirofield are preserved if requested using the flag
63d0cef73dSGregory Neil Shapiro<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>.
64d0cef73dSGregory Neil ShapiroThat is, the header
6540266059SGregory Neil Shapiro
66d0cef73dSGregory Neil Shapiro<PRE>
67d0cef73dSGregory Neil ShapiroFrom: sender &lt;f@example.com&gt;
68d0cef73dSGregory Neil ShapiroTo:  user &lt;t@example.com&gt;
69d0cef73dSGregory Neil ShapiroSubject:no
70d0cef73dSGregory Neil Shapiro</PRE>
71d0cef73dSGregory Neil Shapiro
72d0cef73dSGregory Neil Shapirowill be sent to a milter as
73d0cef73dSGregory Neil Shapiro
74d0cef73dSGregory Neil Shapiro<PRE>
75d0cef73dSGregory Neil Shapiro"From", " sender &lt;f@example.com&gt;"
76d0cef73dSGregory Neil Shapiro"To", "  user &lt;t@example.com&gt;"
77d0cef73dSGregory Neil Shapiro"Subject", "no"
78d0cef73dSGregory Neil Shapiro</PRE>
79d0cef73dSGregory Neil Shapiro
80d0cef73dSGregory Neil Shapirowhile previously
81d0cef73dSGregory Neil Shapiro(or without the flag
82d0cef73dSGregory Neil Shapiro<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>)
83d0cef73dSGregory Neil Shapiroit was:
84d0cef73dSGregory Neil Shapiro
85d0cef73dSGregory Neil Shapiro<PRE>
86d0cef73dSGregory Neil Shapiro"From", "sender &lt;f@example.com&gt;"
87d0cef73dSGregory Neil Shapiro"To", "user &lt;t@example.com&gt;"
88d0cef73dSGregory Neil Shapiro"Subject", "no"
89d0cef73dSGregory Neil Shapiro</PRE>
90d0cef73dSGregory Neil Shapiro
91d0cef73dSGregory Neil Shapiro
92d0cef73dSGregory Neil Shapiro<LI>Later filters will see header changes/additions made by earlier ones.
93d0cef73dSGregory Neil Shapiro<LI>For much more detail about header format, please see
94d0cef73dSGregory Neil ShapiroRFC <A href="http://www.rfc-editor.org/rfc/rfc822.html">822</A>
95d0cef73dSGregory Neil Shapiroand
96d0cef73dSGregory Neil ShapiroRFC <A href="http://www.rfc-editor.org/rfc/rfc2822.html">2822</A>
97d0cef73dSGregory Neil Shapiro</UL>
98d0cef73dSGregory Neil Shapiro</TD>
99d0cef73dSGregory Neil Shapiro</TR>
100d0cef73dSGregory Neil Shapiro</TABLE>
101d0cef73dSGregory Neil Shapiro
102d0cef73dSGregory Neil Shapiro<HR size="1">
103d0cef73dSGregory Neil Shapiro<FONT size="-1">
104af9557fdSGregory Neil ShapiroCopyright (c) 2000, 2003, 2006 Sendmail, Inc. and its suppliers.
10540266059SGregory Neil ShapiroAll rights reserved.
106d0cef73dSGregory Neil Shapiro<BR>
10740266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
1085ef517c0SGregory Neil Shapiroforth in the LICENSE.
109d0cef73dSGregory Neil Shapiro</FONT>
110d0cef73dSGregory Neil Shapiro</BODY>
111d0cef73dSGregory Neil Shapiro</HTML>
112