Update of mhonarc/MHonArc/doc
Modified Files:
app-api.html relnotes.html
Log Message:
The return value for $mhonarc::CBMessageBodyRead and
$mhonarc::CBRawMessageBodyRead is no longer N/A. If the return
value evaluates to false, the current message will be excluded from
the archive and further processing. A true value must be returned
if the message is to not be excluded.
======================================================================
FILE: mhonarc/MHonArc/doc/app-api.html
<http://www.mhonarc.org/cgi-bin/viewcvs.cgi/*checkout*/mhonarc/MHonArc/doc/app-api.html?rev=1.14>
<http://www.mhonarc.org/cgi-bin/viewcvs.cgi/mhonarc/MHonArc/doc/app-api.html.diff?r1=1.13&r2=1.14&diff_format=h>
--- app-api.html 26 May 2005 22:22:45 -0000 1.13
+++ app-api.html 2 Jun 2005 02:12:29 -0000 1.14
@@ -319,6 +319,6 @@
<p><b>Synopsis:</b></p>
<pre class="code">
-&$mhonarc::CBMessageBodyRead(
- $fields_hash_ref, $html_text_ref, $files_array_ref);
+$boolean = &$mhonarc::CBMessageBodyRead(
+ $fields_hash_ref, $html_text_ref, $files_array_ref);
</pre>
@@ -372,5 +372,10 @@
<p><b>Return Value:</b></p>
- <p>N/A</p>
+ <p>The return value is used by MHonArc to determine if the
+ message should be excluded from any further processing.
+ If the return value evaluates to true, then MHonArc will
+ continue processing of the message. If the return value
+ evaluates to false, the message will be excluded.
+ </p>
<p><b>Notes:</b></p>
@@ -518,5 +523,6 @@
<p><b>Synopsis:</b></p>
<pre class="code">
-&$mhonarc::CBRawMessageBodyRead($fields_hash_ref, $body_data_ref);
+$boolean = &$mhonarc::CBRawMessageBodyRead(
+ $fields_hash_ref, $body_data_ref);
</pre>
@@ -539,5 +545,10 @@
<p><b>Return Value:</b></p>
- <p>N/A</p>
+ <p>The return value is used by MHonArc to determine if the
+ message should be excluded from any further processing.
+ If the return value evaluates to true, then MHonArc will
+ continue processing of the message. If the return value
+ evaluates to false, the message will be excluded.
+ </p>
</div>
======================================================================
FILE: mhonarc/MHonArc/doc/relnotes.html
<http://www.mhonarc.org/cgi-bin/viewcvs.cgi/*checkout*/mhonarc/MHonArc/doc/relnotes.html?rev=1.21>
<http://www.mhonarc.org/cgi-bin/viewcvs.cgi/mhonarc/MHonArc/doc/relnotes.html.diff?r1=1.20&r2=1.21&diff_format=h>
--- relnotes.html 13 May 2005 00:00:35 -0000 1.20
+++ relnotes.html 2 Jun 2005 02:12:29 -0000 1.21
@@ -38,5 +38,6 @@
<li><a href="#important">Compatibility Notes</a>
<ul>
-<li><small><a href="#v2.4.x-defrcname">UPGRADING FROM v2.5.x OR EARLIER: Default iso-2022-jp Converter Changed</a></small>
+<li><small><a href="#v2.6.11-cbbodyread">UPGRADING FROM v2.6.11 OR EARLIER: Handling of return value for $mhonarc::CB{Raw}MessageBodyRead Changed</a></small>
+<li><small><a href="#v2.5.x-iso-2022-jp">UPGRADING FROM v2.5.x OR EARLIER: Default iso-2022-jp Converter Changed</a></small>
<li><small><a href="#v2.4.x-defrcname">UPGRADING FROM v2.4.x OR EARLIER: DEFRCNAME Change</a></small>
<li><small><a href="#v2.4.x-header-footer">UPGRADING FROM v2.4.x OR EARLIER: HEADER and FOOTER Removed</a></small>
@@ -77,5 +78,44 @@
</p>
-<h3><a name="v2.4.x-defrcname">UPGRADING FROM v2.5.x OR EARLIER: Default iso-2022-jp Converter Changed</a></h3>
+<h3><a name="v2.6.11-cbbodyread">UPGRADING FROM v2.6.11 OR EARLIER: Handling of return value for $mhonarc::CB{Raw}MessageBodyRead Changed</a></h3>
+
+ <table class="note" width="100%">
+ <tr valign="baseline">
+ <td><strong>NOTE:</strong></td>
+ <td width="100%"><p>If you do not utilize MHonArc's
+ <a href="app-api.html">callback API</a>, you can ignore this compatibility
+ item. <b>However</b>, if you use the <tt>mha-preview</tt> example script,
+ continuing reading.
+ </p>
+ </td>
+ </tr>
+ </table>
+ <p>In v2.6.12, the return value for the
+ <a href="app-api.html#CBMessageBodyRead">$mhonarc::CBMessageBodyRead</a>
+ and
+ <a href="app-api.html#CBRawMessageBodyRead">$mhonarc::CBRawMessageBodyRead</a>
+ is now checked to see if the message should be excluded from further
+ processing. In previous versions, the return value was N/A. Therefore,
+ if you use either of these callbacks, and the return value of your
+ routines evaluates to false for a given message, the message will
+ be excluded from the archive.
+ </p>
+ <p>If you never want to exclude messages with either of these callbacks,
+ have your routines already return <tt>1</tt>.
+ </p>
+ <table class="note" width="100%">
+ <tr valign="baseline">
+ <td><strong>NOTE:</strong></td>
+ <td width="100%"><p>The example <tt>mha-preview</tt> script provided
+ in the MHonArc distribution has been updated to reflect the change
+ in return value handling. Even though it is statistically unlikely
+ messages will be quietly excluded with older versions of the script,
+ it is recommended replace your copy with the latest version.
+ </p>
+ </td>
+ </tr>
+ </table>
+
+<h3><a name="v2.5.x-iso-2022-jp">UPGRADING FROM v2.5.x OR EARLIER: Default iso-2022-jp Converter Changed</a></h3>
<p>In v2.6, the <strong>default</strong>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-COMMITS