aboutsummaryrefslogtreecommitdiff
path: root/libmilter/docs
diff options
context:
space:
mode:
authorGregory Neil Shapiro <gshapiro@FreeBSD.org>2010-01-26 04:17:18 +0000
committerGregory Neil Shapiro <gshapiro@FreeBSD.org>2010-01-26 04:17:18 +0000
commit09b16018d032d94de7fbaf59c4d6fc4a43c4d610 (patch)
tree25902a53d874255d42002dd157e36601e71e2df5 /libmilter/docs
parent7db286411e6127edcdd31f558ac20de5c63055b0 (diff)
Notes
Diffstat (limited to 'libmilter/docs')
-rw-r--r--libmilter/docs/api.html8
-rw-r--r--libmilter/docs/overview.html6
-rw-r--r--libmilter/docs/smfi_addheader.html10
-rw-r--r--libmilter/docs/smfi_chgheader.html9
-rw-r--r--libmilter/docs/smfi_insheader.html9
5 files changed, 30 insertions, 12 deletions
diff --git a/libmilter/docs/api.html b/libmilter/docs/api.html
index 4214df4dd87a..578e0ca686af 100644
--- a/libmilter/docs/api.html
+++ b/libmilter/docs/api.html
@@ -2,7 +2,7 @@
<HEAD><TITLE>Milter API</TITLE></HEAD>
<BODY>
<!--
-$Id: api.html,v 1.35 2006/11/30 23:09:23 ca Exp $
+$Id: api.html,v 1.37 2009/05/19 00:40:52 ca Exp $
-->
<H1>Milter API</H1>
@@ -80,7 +80,9 @@ The following functions change a message's contents and attributes.
<EM>They may only be called in <A HREF="xxfi_eom.html">xxfi_eom</A></EM>.
All of these functions may invoke additional communication with the MTA.
They will return either MI_SUCCESS or MI_FAILURE to indicate the status of
-the operation.
+the operation. Message data (senders, recipients, headers, body chunks)
+passed to these functions via parameters is copied and does not need to be
+preserved (i.e., allocated memory can be freed).
<P>
A filter must have set the appropriate flag (listed below) in the
@@ -310,7 +312,7 @@ for a protocol stage.
<HR SIZE="1">
<FONT SIZE="-1">
-Copyright (c) 2000, 2003, 2006 Sendmail, Inc. and its suppliers.
+Copyright (c) 2000, 2003, 2006, 2009 Sendmail, Inc. and its suppliers.
All rights reserved.
<BR>
By using this file, you agree to the terms and conditions set
diff --git a/libmilter/docs/overview.html b/libmilter/docs/overview.html
index b7e80dfdbed7..5c6f21ce4ce1 100644
--- a/libmilter/docs/overview.html
+++ b/libmilter/docs/overview.html
@@ -4,7 +4,7 @@
</HEAD>
<BODY>
<!--
-$Id: overview.html,v 1.19 2006/12/21 18:23:47 ca Exp $
+$Id: overview.html,v 1.20 2009/11/13 18:15:05 ca Exp $
-->
<H1>Technical Overview</H1>
@@ -60,7 +60,9 @@ returns to <CODE>MESSAGE</CODE>.
For each of N connections
{
For each filter
- process connection/helo (<A HREF="xxfi_connect.html">xxfi_connect</A>, <A HREF="xxfi_helo.html">xxfi_helo</A>)
+ process connection (<A HREF="xxfi_connect.html">xxfi_connect</A>)
+ For each filter
+ process helo/ehlo (<A HREF="xxfi_helo.html">xxfi_helo</A>)
MESSAGE:For each message in this connection (sequentially)
{
For each filter
diff --git a/libmilter/docs/smfi_addheader.html b/libmilter/docs/smfi_addheader.html
index d068f9fdb934..460b4caf7cf1 100644
--- a/libmilter/docs/smfi_addheader.html
+++ b/libmilter/docs/smfi_addheader.html
@@ -2,7 +2,7 @@
<HEAD><TITLE>smfi_addheader</TITLE></HEAD>
<BODY>
<!--
-$Id: smfi_addheader.html,v 1.19 2006/12/21 18:30:35 ca Exp $
+$Id: smfi_addheader.html,v 1.20 2009/05/18 23:51:23 ca Exp $
-->
<H1>smfi_addheader</H1>
@@ -90,7 +90,11 @@ To change a header's current value, use
the MTA will add this automatically.
<B>It is the filter writer's responsibility to ensure that no standards
are violated.</B>
- <LI>The MTA adds a leading space to an added header value.
+ <LI>The MTA adds a leading space to an added header value unless
+ the flag
+<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>
+ is set, in which case the milter
+ must include any desired leading spaces itself.
</UL>
</TD>
</TR>
@@ -116,7 +120,7 @@ To change a header's current value, use
<HR size="1">
<FONT size="-1">
-Copyright (c) 2000-2003, 2006 Sendmail, Inc. and its suppliers.
+Copyright (c) 2000-2003, 2006, 2009 Sendmail, Inc. and its suppliers.
All rights reserved.
<BR>
By using this file, you agree to the terms and conditions set
diff --git a/libmilter/docs/smfi_chgheader.html b/libmilter/docs/smfi_chgheader.html
index 0701a3671aaf..517b5ba4c1c8 100644
--- a/libmilter/docs/smfi_chgheader.html
+++ b/libmilter/docs/smfi_chgheader.html
@@ -2,7 +2,7 @@
<HEAD><TITLE>smfi_chgheader</TITLE></HEAD>
<BODY>
<!--
-$Id: smfi_chgheader.html,v 1.17 2006/12/21 18:30:35 ca Exp $
+$Id: smfi_chgheader.html,v 1.18 2009/05/18 23:51:23 ca Exp $
-->
<H1>smfi_chgheader</H1>
@@ -85,6 +85,11 @@ Otherwise, it returns MI_SUCCESS.
carriage return (ASCII 0x0d); the MTA will add this automatically.
<B>It is the filter writer's responsibility to ensure that no standards
are violated.</B>
+ <LI>The MTA adds a leading space to a header value unless
+ the flag
+<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>
+ is set, in which case the milter
+ must include any desired leading spaces itself.
</UL>
</TD>
</TR>
@@ -110,7 +115,7 @@ Otherwise, it returns MI_SUCCESS.
<HR size="1">
<FONT size="-1">
-Copyright (c) 2000-2003 Sendmail, Inc. and its suppliers.
+Copyright (c) 2000-2003, 2009 Sendmail, Inc. and its suppliers.
All rights reserved.
<BR>
By using this file, you agree to the terms and conditions set
diff --git a/libmilter/docs/smfi_insheader.html b/libmilter/docs/smfi_insheader.html
index a4ba77f33d4f..5962e61afea1 100644
--- a/libmilter/docs/smfi_insheader.html
+++ b/libmilter/docs/smfi_insheader.html
@@ -2,7 +2,7 @@
<HEAD><TITLE>smfi_insheader</TITLE></HEAD>
<BODY>
<!--
-$Id: smfi_insheader.html,v 1.9 2006/12/21 18:30:35 ca Exp $
+$Id: smfi_insheader.html,v 1.10 2009/05/18 23:51:23 ca Exp $
-->
<H1>smfi_insheader</H1>
@@ -111,6 +111,11 @@ Otherwise, it returns MI_SUCCESS.
the MTA will add this automatically.
<B>It is the filter writer's responsibility to ensure that no standards
are violated.</B>
+ <LI>The MTA adds a leading space to an inserted header value unless
+ the flag
+<A HREF="xxfi_negotiate.html#SMFIP_HDR_LEADSPC"><CODE>SMFIP_HDR_LEADSPC</CODE></A>
+ is set, in which case the milter
+ must include any desired leading spaces itself.
</UL>
</TD>
</TR>
@@ -135,7 +140,7 @@ Otherwise, it returns MI_SUCCESS.
<HR size="1">
<FONT size="-1">
-Copyright (c) 2004, 2006 Sendmail, Inc. and its suppliers.
+Copyright (c) 2004, 2006, 2009 Sendmail, Inc. and its suppliers.
All rights reserved.
<BR>
By using this file, you agree to the terms and conditions set