2 <HEAD><TITLE>xxfi_body</TITLE></HEAD>
5 $Id: xxfi_body.html,v 1.18 2013-11-22 20:51:39 ca Exp $
9 <TABLE border="0" cellspacing=4 cellpadding=4>
10 <!---------- Synopsis ----------->
11 <TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
13 #include <libmilter/mfapi.h>
14 sfsistat (*xxfi_body)(
20 Handle a piece of a message's body.
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_body is called zero or more times between xxfi_eoh and xxfi_eom.</TD>
30 <TR align="left" valign=top>
31 <TH>Default Behavior</TH>
32 <TD>Do nothing; return SMFIS_CONTINUE.</TD>
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.
44 <TR valign="top"><TD>bodyp</TD>
45 <TD>Pointer to the start of this block of body data. bodyp is not valid outside this call to xxfi_body.
47 <TR valign="top"><TD>len</TD>
48 <TD>The amount of data pointed to by bodyp.
53 <!----------- Notes ---------->
55 <TH valign="top" align=left>NOTES</TH>
58 <LI>bodyp points to a sequence of bytes.
59 It is <EM>not</EM> a C string (a sequence of characters that is terminated by '\0').
60 Therefore, do not use the usual C string functions like <CODE>strlen(3)</CODE>
62 Moreover, the byte sequence may contain '\0' characters inside the block.
63 Hence even if a trailing '\0' is added, C string functions may still fail
65 <LI>Since message bodies can be very large, defining xxfi_body can
66 significantly impact filter performance.
67 <LI>End-of-lines are represented as received from SMTP (normally CRLF).
68 <LI>Later filters will see body changes made by earlier ones.
69 <LI>Message bodies may be sent in multiple chunks, with one call to
72 <A HREF="api.html#SMFIS_SKIP">SMFIS_SKIP</A>
73 if a milter has received sufficiently many
74 body chunks to make a decision,
75 but still wants to invoke
76 message modification functions that are only allowed to be called from
77 <A HREF="xxfi_eom.html">xxfi_eom()</A>.
78 Note: the milter <EM>must</EM>
79 <A HREF="xxfi_negotiate.html">negotiate</A>
80 this behavior with the MTA, i.e., it must check whether
82 <A HREF="xxfi_negotiate.html#SMFIP_SKIP"><CODE>SMFIP_SKIP</CODE></A>
83 is available and if so, the milter must request it.
91 Copyright (c) 2000-2003, 2007 Proofpoint, Inc. and its suppliers.
94 By using this file, you agree to the terms and conditions set