contrib/sendmail/libmilter/docs/xxfi_header.html

   1 <html>
   2 <head><title>xxfi_header</title></head>
   3 <body>
   4 <h1>xxfi_header</h1>
   5
   6 <table border="0" cellspacing=4 cellpadding=4>
   7 <!---------- Synopsis ----------->
   8 <tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
   9 <pre>
  10 #include &lt;libmilter/mfapi.h&gt;
  11 sfsistat (*xxfi_header)(
  12         SMFICTX * ctx,
  13         char * headerf,
  14         char * headerv
  15 );
  16 </pre>
  17 Handle a message header.
  18 </td></tr>
  19
  20 <!----------- Description ---------->
  21 <tr><th valign="top" align=left>DESCRIPTION</th><td>
  22 <table border="1" cellspacing=1 cellpadding=4>
  23 <tr align="left" valign=top>
  24 <th width="80">Called When</th>
  25 <td>xxfi_header is called zero or more times between xxfi_envrcpt and xxfi_eoh, once per message header.</td>
  26 </tr>
  27 <tr align="left" valign=top>
  28 <th>Default Behavior</th>
  29 <td>Do nothing; return SMFIS_CONTINUE.</td>
  30 </tr>
  31 </table>
  32
  33 <!----------- Arguments ---------->
  34 <tr><th valign="top" align=left>ARGUMENTS</th><td>
  35     <table border="1" cellspacing=0>
  36     <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
  37     <tr valign="top"><td>ctx</td>
  38         <td>Opaque context structure.
  39         </td></tr>
  40     <tr valign="top"><td>headerf</td>
  41         <td> Header field name.
  42         </td></tr>
  43     <tr valign="top"><td>headerv</td>
  44         <td>Header field value.  The
  45   content of the header may include folded white space (i.e. multiple
  46   lines with following white space).  The trailing line terminator (CR/LF)
  47   is removed.
  48         </td></tr>
  49     </table>
  50 </td></tr>
  51
  52 <!----------- Notes ---------->
  53 <tr>
  54 <th valign="top" align=left>NOTES</th>
  55 <td>
  56 <ul>
  57 <li>Later filters will see header changes/additions made by earlier ones.
  58 <li>For much more detail about header format, please see
  59 RFC <a href="http://www.rfc-editor.org/rfc/rfc822.html">822</a>
  60 </ul>
  61 </td>
  62 </tr>
  63 </table>
  64
  65 <hr size="1">
  66 <font size="-1">
  67 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  68 All rights reserved.
  69 <br>
  70 By using this file, you agree to the terms and conditions set
  71 forth in the LICENSE.
  72 </font>
  73 </body>
  74 </html>