contrib/sendmail/libmilter/docs/xxfi_header.html

   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;
  14 sfsistat (*xxfi_header)(
  15         SMFICTX *ctx,
  16         char *headerf,
  17         char *headerv
  18 );
  19 </PRE>
  20 Handle 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 </TD></TR>
  36
  37 <!----------- Arguments ---------->
  38 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
  39     <TABLE border="1" cellspacing=0>
  40     <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
  41     <TR valign="top"><TD>ctx</TD>
  42         <TD>Opaque context structure.
  43         </TD></TR>
  44     <TR valign="top"><TD>headerf</TD>
  45         <TD> Header field name.
  46         </TD></TR>
  47     <TR valign="top"><TD>headerv</TD>
  48         <TD>Header field value.
  49         The content of the header may include folded white space,
  50         i.e., multiple lines with following white space
  51         where lines are separated by LF (not CR/LF).
  52         The trailing line terminator (CR/LF) is removed.
  53         </TD></TR>
  54     </TABLE>
  55 </TD></TR>
  56
  57 <!----------- Notes ---------->
  58 <TR>
  59 <TH valign="top" align=left>NOTES</TH>
  60 <TD>
  61 <UL>
  62 <LI>Starting with sendmail 8.14, spaces after the colon in a header
  63 field are preserved if requested using the flag
  64 <A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>.
  65 That is, the header
  66
  67 <PRE>
  68 From: sender &lt;f@example.com&gt;
  69 To:  user &lt;t@example.com&gt;
  70 Subject:no
  71 </PRE>
  72
  73 will be sent to a milter as
  74
  75 <PRE>
  76 "From", " sender &lt;f@example.com&gt;"
  77 "To", "  user &lt;t@example.com&gt;"
  78 "Subject", "no"
  79 </PRE>
  80
  81 while previously
  82 (or without the flag
  83 <A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>)
  84 it was:
  85
  86 <PRE>
  87 "From", "sender &lt;f@example.com&gt;"
  88 "To", "user &lt;t@example.com&gt;"
  89 "Subject", "no"
  90 </PRE>
  91
  92
  93 <LI>Later filters will see header changes/additions made by earlier ones.
  94 <LI>For much more detail about header format, please see
  95 RFC <A href="http://www.rfc-editor.org/rfc/rfc822.html">822</A>
  96 and
  97 RFC <A href="http://www.rfc-editor.org/rfc/rfc2822.html">2822</A>
  98 </UL>
  99 </TD>
 100 </TR>
 101 </TABLE>
 102
 103 <HR size="1">
 104 <FONT size="-1">
 105 Copyright (c) 2000, 2003, 2006 Proofpoint, Inc. and its suppliers.
 106 All rights reserved.
 107 <BR>
 108 By using this file, you agree to the terms and conditions set
 109 forth in the LICENSE.
 110 </FONT>
 111 </BODY>
 112 </HTML>