xref: /freebsd/contrib/sendmail/libmilter/docs/xxfi_header.html (revision 6cec9cad762b6476313fb1f8e931a1647822db6b)
1<HTML>
2<HEAD><TITLE>xxfi_header</TITLE></HEAD>
3<BODY>
4<!--
5$Id: xxfi_header.html,v 1.18 2013-11-22 20:51:39 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=100>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 once for each 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>Starting with sendmail 8.14, spaces after the colon in a header
62field are preserved if requested using the flag
63<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>.
64That is, the header
65
66<PRE>
67From: sender &lt;f@example.com&gt;
68To:  user &lt;t@example.com&gt;
69Subject:no
70</PRE>
71
72will be sent to a milter as
73
74<PRE>
75"From", " sender &lt;f@example.com&gt;"
76"To", "  user &lt;t@example.com&gt;"
77"Subject", "no"
78</PRE>
79
80while previously
81(or without the flag
82<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>)
83it was:
84
85<PRE>
86"From", "sender &lt;f@example.com&gt;"
87"To", "user &lt;t@example.com&gt;"
88"Subject", "no"
89</PRE>
90
91
92<LI>Later filters will see header changes/additions made by earlier ones.
93<LI>For much more detail about header format, please see
94RFC <A href="http://www.rfc-editor.org/rfc/rfc822.html">822</A>
95and
96RFC <A href="http://www.rfc-editor.org/rfc/rfc2822.html">2822</A>
97</UL>
98</TD>
99</TR>
100</TABLE>
101
102<HR size="1">
103<FONT size="-1">
104Copyright (c) 2000, 2003, 2006 Proofpoint, Inc. and its suppliers.
105All rights reserved.
106<BR>
107By using this file, you agree to the terms and conditions set
108forth in the LICENSE.
109</FONT>
110</BODY>
111</HTML>
112