You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2008/08/23 15:40:31 UTC
svn commit: r688320 [44/47] - in /james/site/trunk/www/mailet/standard: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/james/
apidocs/org/apache/james/transport/
apidocs/org/apache/james/transport/mailets/ apidocs/org/apache/james/tran...
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/ExceptionThrowingMailet.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/ExceptionThrowingMailet.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/ExceptionThrowingMailet.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/ExceptionThrowingMailet.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,69 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>ExceptionThrowingMailet xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/james/transport/mailets/debug/ExceptionThrowingMailet.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.mailets.debug;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.MailetException;
+<a name="27" href="#27">27</a>
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Debugging purpose Mailet. Just throws an exception.</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em>
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/james/transport/mailets/debug/ExceptionThrowingMailet.html">ExceptionThrowingMailet</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<a name="35" href="#35">35</a>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Throw an exception if any mail is processed.</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @param mail the mail to process</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @throws MailetException in all cases</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
+<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> service(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="44" href="#44">44</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MailetException(<span class="jxr_string">"General protection fault"</span>);
+<a name="45" href="#45">45</a> }
+<a name="46" href="#46">46</a>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Return a string describing this mailet.</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> *</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @return a string describing this mailet</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> String getMailetInfo() {
+<a name="53" href="#53">53</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"ExceptionThrowingMailet Mailet"</span>;
+<a name="54" href="#54">54</a> }
+<a name="55" href="#55">55</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/Identity.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/Identity.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/Identity.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/Identity.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,65 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>Identity xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/james/transport/mailets/debug/Identity.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.mailets.debug;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="26" href="#26">26</a>
+<a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Opposite of Null Mailet. It let any incoming mail untouched. Used only for</em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * debugging.</em>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> */</em>
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/james/transport/mailets/debug/Identity.html">Identity</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<a name="32" href="#32">32</a>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Do nothing.</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @param mail the mail to be processed</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em>
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> service(Mail mail) {
+<a name="39" href="#39">39</a> <em class="jxr_comment">//Do nothing</em>
+<a name="40" href="#40">40</a> }
+<a name="41" href="#41">41</a>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Return a string describing this mailet.</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> *</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @return a string describing this mailet</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> String getMailetInfo() {
+<a name="48" href="#48">48</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Identity Mailet"</span>;
+<a name="49" href="#49">49</a> }
+<a name="50" href="#50">50</a> }
+<a name="51" href="#51">51</a>
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-frame.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-frame.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-frame.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-frame.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,33 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Apache JAMES Standard Mailets 1.0-SNAPSHOT Reference Package org.apache.james.transport.mailets.debug</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">org.apache.james.transport.mailets.debug</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="Counter.html" target="classFrame">Counter</a>
+ </li>
+ <li>
+ <a href="DumpSystemErr.html" target="classFrame">DumpSystemErr</a>
+ </li>
+ <li>
+ <a href="ExceptionThrowingMailet.html" target="classFrame">ExceptionThrowingMailet</a>
+ </li>
+ <li>
+ <a href="Identity.html" target="classFrame">Identity</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-summary.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-summary.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-summary.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/debug/package-summary.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,82 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Apache JAMES Standard Mailets 1.0-SNAPSHOT Reference Package org.apache.james.transport.mailets.debug</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package org.apache.james.transport.mailets.debug</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="Counter.html" target="classFrame">Counter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="DumpSystemErr.html" target="classFrame">DumpSystemErr</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ExceptionThrowingMailet.html" target="classFrame">ExceptionThrowingMailet</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="Identity.html" target="classFrame">Identity</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2008 The Apache Software Foundation. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-frame.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-frame.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-frame.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-frame.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,84 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Apache JAMES Standard Mailets 1.0-SNAPSHOT Reference Package org.apache.james.transport.mailets</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">org.apache.james.transport.mailets</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="AbstractAddFooter.html" target="classFrame">AbstractAddFooter</a>
+ </li>
+ <li>
+ <a href="AddFooter.html" target="classFrame">AddFooter</a>
+ </li>
+ <li>
+ <a href="AddHabeasWarrantMark.html" target="classFrame">AddHabeasWarrantMark</a>
+ </li>
+ <li>
+ <a href="AddSubjectPrefix.html" target="classFrame">AddSubjectPrefix</a>
+ </li>
+ <li>
+ <a href="ClamAVScan.html" target="classFrame">ClamAVScan</a>
+ </li>
+ <li>
+ <a href="LogMessage.html" target="classFrame">LogMessage</a>
+ </li>
+ <li>
+ <a href="MailAttributesToMimeHeaders.html" target="classFrame">MailAttributesToMimeHeaders</a>
+ </li>
+ <li>
+ <a href="Null.html" target="classFrame">Null</a>
+ </li>
+ <li>
+ <a href="OnlyText.html" target="classFrame">OnlyText</a>
+ </li>
+ <li>
+ <a href="PostmasterAlias.html" target="classFrame">PostmasterAlias</a>
+ </li>
+ <li>
+ <a href="RemoveAllMailAttributes.html" target="classFrame">RemoveAllMailAttributes</a>
+ </li>
+ <li>
+ <a href="RemoveMailAttribute.html" target="classFrame">RemoveMailAttribute</a>
+ </li>
+ <li>
+ <a href="RemoveMimeHeader.html" target="classFrame">RemoveMimeHeader</a>
+ </li>
+ <li>
+ <a href="ReplaceContent.html" target="classFrame">ReplaceContent</a>
+ </li>
+ <li>
+ <a href="ServerTime.html" target="classFrame">ServerTime</a>
+ </li>
+ <li>
+ <a href="SetMailAttribute.html" target="classFrame">SetMailAttribute</a>
+ </li>
+ <li>
+ <a href="SetMimeHeader.html" target="classFrame">SetMimeHeader</a>
+ </li>
+ <li>
+ <a href="ToProcessor.html" target="classFrame">ToProcessor</a>
+ </li>
+ <li>
+ <a href="UnwrapText.html" target="classFrame">UnwrapText</a>
+ </li>
+ <li>
+ <a href="UseHeaderRecipients.html" target="classFrame">UseHeaderRecipients</a>
+ </li>
+ <li>
+ <a href="WrapText.html" target="classFrame">WrapText</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-summary.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-summary.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-summary.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/package-summary.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,167 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Apache JAMES Standard Mailets 1.0-SNAPSHOT Reference Package org.apache.james.transport.mailets</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package org.apache.james.transport.mailets</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="AbstractAddFooter.html" target="classFrame">AbstractAddFooter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="AddFooter.html" target="classFrame">AddFooter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="AddHabeasWarrantMark.html" target="classFrame">AddHabeasWarrantMark</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="AddSubjectPrefix.html" target="classFrame">AddSubjectPrefix</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ClamAVScan.html" target="classFrame">ClamAVScan</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="LogMessage.html" target="classFrame">LogMessage</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="MailAttributesToMimeHeaders.html" target="classFrame">MailAttributesToMimeHeaders</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="Null.html" target="classFrame">Null</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="OnlyText.html" target="classFrame">OnlyText</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="PostmasterAlias.html" target="classFrame">PostmasterAlias</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="RemoveAllMailAttributes.html" target="classFrame">RemoveAllMailAttributes</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="RemoveMailAttribute.html" target="classFrame">RemoveMailAttribute</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="RemoveMimeHeader.html" target="classFrame">RemoveMimeHeader</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ReplaceContent.html" target="classFrame">ReplaceContent</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ServerTime.html" target="classFrame">ServerTime</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SetMailAttribute.html" target="classFrame">SetMailAttribute</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SetMimeHeader.html" target="classFrame">SetMimeHeader</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ToProcessor.html" target="classFrame">ToProcessor</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="UnwrapText.html" target="classFrame">UnwrapText</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="UseHeaderRecipients.html" target="classFrame">UseHeaderRecipients</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="WrapText.html" target="classFrame">WrapText</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2008 The Apache Software Foundation. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AbstractQuotaMatcher.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AbstractQuotaMatcher.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AbstractQuotaMatcher.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AbstractQuotaMatcher.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,165 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>AbstractQuotaMatcher xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/matchers/AbstractQuotaMatcher.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.matchers;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMatcher;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.MailAddress;
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <P>Abstract matcher checking whether a recipient has exceeded a maximum allowed quota.</P></em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <P>"Quota" at this level is an abstraction whose specific interpretation</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * will be done by subclasses.</P> </em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <P>Although extending GenericMatcher, its logic is recipient oriented.</P></em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @version CVS $Revision: 426098 $ $Date: 2006-07-27 16:10:07 +0100 (Thu, 27 Jul 2006) $</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @since 2.2.0</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/matchers/AbstractQuotaMatcher.html">AbstractQuotaMatcher</a> <strong class="jxr_keyword">extends</strong> GenericMatcher {
+<a name="42" href="#42">42</a>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Standard matcher entrypoint.</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * First of all, checks the sender using {@link #isSenderChecked}.</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Then, for each recipient checks it using {@link #isRecipientChecked} and</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * {@link #isOverQuota}.</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> *</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @throws MessagingException if either <CODE>isSenderChecked</CODE> or isRecipientChecked throw an exception</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
+<a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> Collection match(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="52" href="#52">52</a> Collection matching = <strong class="jxr_keyword">null</strong>;
+<a name="53" href="#53">53</a> <strong class="jxr_keyword">if</strong> (isSenderChecked(mail.getSender())) {
+<a name="54" href="#54">54</a> matching = <strong class="jxr_keyword">new</strong> ArrayList();
+<a name="55" href="#55">55</a> <strong class="jxr_keyword">for</strong> (Iterator i = mail.getRecipients().iterator(); i.hasNext(); ) {
+<a name="56" href="#56">56</a> MailAddress recipient = (MailAddress) i.next();
+<a name="57" href="#57">57</a> <strong class="jxr_keyword">if</strong> (isRecipientChecked(recipient) && isOverQuota(recipient, mail)) {
+<a name="58" href="#58">58</a> matching.add(recipient);
+<a name="59" href="#59">59</a> }
+<a name="60" href="#60">60</a> }
+<a name="61" href="#61">61</a> }
+<a name="62" href="#62">62</a> <strong class="jxr_keyword">return</strong> matching;
+<a name="63" href="#63">63</a> }
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Does the quota check.</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Checks if {@link #getQuota} < {@link #getUsed} for a recipient.</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Catches any throwable returning false, and so should any override do.</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @param address the recipient addresss to check</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param mail the mail involved in the check</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return true if over quota</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
+<a name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isOverQuota(MailAddress address, Mail mail) {
+<a name="75" href="#75">75</a> <strong class="jxr_keyword">try</strong> {
+<a name="76" href="#76">76</a> <strong class="jxr_keyword">boolean</strong> over = getQuota(address, mail) < getUsed(address, mail);
+<a name="77" href="#77">77</a> <strong class="jxr_keyword">if</strong> (over) log(address + <span class="jxr_string">" is over quota."</span>);
+<a name="78" href="#78">78</a> <strong class="jxr_keyword">return</strong> over;
+<a name="79" href="#79">79</a> } <strong class="jxr_keyword">catch</strong> (Throwable e) {
+<a name="80" href="#80">80</a> log(<span class="jxr_string">"Exception checking quota for: "</span> + address, e);
+<a name="81" href="#81">81</a> <strong class="jxr_keyword">return</strong> false;
+<a name="82" href="#82">82</a> }
+<a name="83" href="#83">83</a> }
+<a name="84" href="#84">84</a>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Checks the sender.</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * The default behaviour is to check that the sender <I>is not</I> null nor the local postmaster.</em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * If a subclass overrides this method it should "and" <CODE>super.isSenderChecked</CODE></em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * to its check.</em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em>
+<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param sender the sender to check</em>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> */</em>
+<a name="93" href="#93">93</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isSenderChecked(MailAddress sender) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="94" href="#94">94</a> <strong class="jxr_keyword">return</strong> !(sender == <strong class="jxr_keyword">null</strong> || getMailetContext().getPostmaster().equals(sender));
+<a name="95" href="#95">95</a> }
+<a name="96" href="#96">96</a>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Checks the recipient.</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The default behaviour is to check that the recipient <I>is not</I> the local postmaster.</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * If a subclass overrides this method it should "and" <CODE>super.isRecipientChecked</CODE></em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * to its check.</em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @param recipient the recipient to check</em>
+<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em>
+<a name="105" href="#105">105</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isRecipientChecked(MailAddress recipient) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> !(getMailetContext().getPostmaster().equals(recipient));
+<a name="107" href="#107">107</a> }
+<a name="108" href="#108">108</a>
+<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Gets the quota to check against.</em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> *</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @param address the address holding the quota if applicable</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param mail the mail involved if needed</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> getQuota(MailAddress address, Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException;
+<a name="116" href="#116">116</a>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Gets the used amount to check against the quota.</em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> *</em>
+<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param address the address involved</em>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param mail the mail involved if needed</em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em>
+<a name="123" href="#123">123</a> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> getUsed(MailAddress address, Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException;
+<a name="124" href="#124">124</a>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Utility method that parses an amount string.</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * You can use 'k' and 'm' as optional postfixes to the amount (both upper and lowercase).</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * In other words, "1m" is the same as writing "1024k", which is the same as</em>
+<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * "1048576".</em>
+<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> *</em>
+<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @param amount the amount string to parse</em>
+<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em>
+<a name="133" href="#133">133</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> parseQuota(String amount) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">long</strong> quota;
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">try</strong> {
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">if</strong> (amount.endsWith(<span class="jxr_string">"k"</span>)) {
+<a name="137" href="#137">137</a> amount = amount.substring(0, amount.length() - 1);
+<a name="138" href="#138">138</a> quota = Long.parseLong(amount) * 1024;
+<a name="139" href="#139">139</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (amount.endsWith(<span class="jxr_string">"m"</span>)) {
+<a name="140" href="#140">140</a> amount = amount.substring(0, amount.length() - 1);
+<a name="141" href="#141">141</a> quota = Long.parseLong(amount) * 1024 * 1024;
+<a name="142" href="#142">142</a> } <strong class="jxr_keyword">else</strong> {
+<a name="143" href="#143">143</a> quota = Long.parseLong(amount);
+<a name="144" href="#144">144</a> }
+<a name="145" href="#145">145</a> <strong class="jxr_keyword">return</strong> quota;
+<a name="146" href="#146">146</a> }
+<a name="147" href="#147">147</a> <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="148" href="#148">148</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Exception parsing quota"</span>, e);
+<a name="149" href="#149">149</a> }
+<a name="150" href="#150">150</a> }
+<a name="151" href="#151">151</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/All.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/All.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/All.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/All.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,52 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>All xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/matchers/All.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.matchers;
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMatcher;
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a name="25" href="#25">25</a>
+<a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em>
+<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * Matches all mail.</em>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * @version 1.0.0, 24/04/1999</em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> */</em>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/matchers/All.html">All</a> <strong class="jxr_keyword">extends</strong> GenericMatcher {
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @see org.apache.mailet.GenericMatcher#match(Mail)</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em>
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> Collection match(Mail mail) {
+<a name="36" href="#36">36</a> <strong class="jxr_keyword">return</strong> mail.getRecipients();
+<a name="37" href="#37">37</a> }
+<a name="38" href="#38">38</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AttachmentFileNameIs.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AttachmentFileNameIs.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AttachmentFileNameIs.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/AttachmentFileNameIs.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,278 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>AttachmentFileNameIs xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/matchers/AttachmentFileNameIs.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.matchers;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMatcher;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="26" href="#26">26</a>
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.mail.Multipart;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.mail.Part;
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.StringTokenizer;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipInputStream;
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipEntry;
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
+<a name="39" href="#39">39</a>
+<a name="40" href="#40">40</a>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <P>Checks if at least one attachment has a file name which matches any</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * element of a comma-separated or space-separated list of file name masks.</P></em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <P>Syntax: <CODE>match="AttachmentFileNameIs=[-d] [-z] <I>masks</I>"</CODE></P></em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <P>The match is case insensitive.</P></em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <P>File name masks may start with a wildcard '*'.</P></em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <P>Multiple file name masks can be specified, e.g.: '*.scr,*.bat'.</P></em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <P>If '<CODE>-d</CODE>' is coded, some debug info will be logged.</P></em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <P>If '<CODE>-z</CODE>' is coded, the check will be non-recursively applied</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * to the contents of any attached '*.zip' file.</P></em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @version CVS $Revision: 426098 $ $Date: 2006-07-27 16:10:07 +0100 (Thu, 27 Jul 2006) $</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @since 2.2.0</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
+<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/matchers/AttachmentFileNameIs.html">AttachmentFileNameIs</a> <strong class="jxr_keyword">extends</strong> GenericMatcher {
+<a name="56" href="#56">56</a>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Unzip request parameter. */</em>
+<a name="58" href="#58">58</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String UNZIP_REQUEST_PARAMETER = <span class="jxr_string">"-z"</span>;
+<a name="59" href="#59">59</a>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Debug request parameter. */</em>
+<a name="61" href="#61">61</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEBUG_REQUEST_PARAMETER = <span class="jxr_string">"-d"</span>;
+<a name="62" href="#62">62</a>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Match string for zip files. */</em>
+<a name="64" href="#64">64</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ZIP_SUFFIX = <span class="jxr_string">".zip"</span>;
+<a name="65" href="#65">65</a>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * represents a single parsed file name mask.</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
+<a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/matchers/AttachmentFileNameIs.html">Mask</a> {
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> true if the mask starts with a wildcard asterisk */</em>
+<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> suffixMatch;
+<a name="72" href="#72">72</a>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> file name mask not including the wildcard asterisk */</em>
+<a name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> String matchString;
+<a name="75" href="#75">75</a> }
+<a name="76" href="#76">76</a>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Controls certain log messages.</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em>
+<a name="80" href="#80">80</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isDebug = false;
+<a name="81" href="#81">81</a>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> contains ParsedMask instances, setup by init */</em>
+<a name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/james/transport/matchers/AttachmentFileNameIs.html">Mask</a>[] masks = <strong class="jxr_keyword">null</strong>;
+<a name="84" href="#84">84</a>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> True if unzip is requested. */</em>
+<a name="86" href="#86">86</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> unzipIsRequested;
+<a name="87" href="#87">87</a>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @see org.apache.mailet.GenericMatcher#init()</em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
+<a name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="92" href="#92">92</a> <em class="jxr_comment">/*<em class="jxr_comment"> sets up fileNameMasks variable by parsing the condition */</em></em>
+<a name="93" href="#93">93</a>
+<a name="94" href="#94">94</a> StringTokenizer st = <strong class="jxr_keyword">new</strong> StringTokenizer(getCondition(), <span class="jxr_string">", "</span>, false);
+<a name="95" href="#95">95</a> ArrayList theMasks = <strong class="jxr_keyword">new</strong> ArrayList(20);
+<a name="96" href="#96">96</a> <strong class="jxr_keyword">while</strong> (st.hasMoreTokens()) {
+<a name="97" href="#97">97</a> String fileName = st.nextToken();
+<a name="98" href="#98">98</a>
+<a name="99" href="#99">99</a> <em class="jxr_comment">// check possible parameters at the beginning of the condition</em>
+<a name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (theMasks.size() == 0 && fileName.equalsIgnoreCase(UNZIP_REQUEST_PARAMETER)) {
+<a name="101" href="#101">101</a> unzipIsRequested = <strong class="jxr_keyword">true</strong>;
+<a name="102" href="#102">102</a> log(<span class="jxr_string">"zip file analysis requested"</span>);
+<a name="103" href="#103">103</a> <strong class="jxr_keyword">continue</strong>;
+<a name="104" href="#104">104</a> }
+<a name="105" href="#105">105</a> <strong class="jxr_keyword">if</strong> (theMasks.size() == 0 && fileName.equalsIgnoreCase(DEBUG_REQUEST_PARAMETER)) {
+<a name="106" href="#106">106</a> isDebug = <strong class="jxr_keyword">true</strong>;
+<a name="107" href="#107">107</a> log(<span class="jxr_string">"debug requested"</span>);
+<a name="108" href="#108">108</a> <strong class="jxr_keyword">continue</strong>;
+<a name="109" href="#109">109</a> }
+<a name="110" href="#110">110</a> <a href="../../../../../org/apache/james/transport/matchers/AttachmentFileNameIs.html">Mask</a> mask = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/james/transport/matchers/AttachmentFileNameIs.html">Mask</a>();
+<a name="111" href="#111">111</a> <strong class="jxr_keyword">if</strong> (fileName.startsWith(<span class="jxr_string">"*"</span>)) {
+<a name="112" href="#112">112</a> mask.suffixMatch = <strong class="jxr_keyword">true</strong>;
+<a name="113" href="#113">113</a> mask.matchString = fileName.substring(1);
+<a name="114" href="#114">114</a> } <strong class="jxr_keyword">else</strong> {
+<a name="115" href="#115">115</a> mask.suffixMatch = false;
+<a name="116" href="#116">116</a> mask.matchString = fileName;
+<a name="117" href="#117">117</a> }
+<a name="118" href="#118">118</a> mask.matchString = cleanFileName(mask.matchString);
+<a name="119" href="#119">119</a> theMasks.add(mask);
+<a name="120" href="#120">120</a> }
+<a name="121" href="#121">121</a> masks = (Mask[])theMasks.toArray(<strong class="jxr_keyword">new</strong> Mask[0]);
+<a name="122" href="#122">122</a> }
+<a name="123" href="#123">123</a>
+<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * Either every recipient is matching or neither of them.</em>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @throws MessagingException if no matching attachment is found and at least one exception was thrown</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em>
+<a name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> Collection match(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="129" href="#129">129</a>
+<a name="130" href="#130">130</a> <strong class="jxr_keyword">try</strong> {
+<a name="131" href="#131">131</a> MimeMessage message = mail.getMessage();
+<a name="132" href="#132">132</a>
+<a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> (matchFound(message)) {
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> mail.getRecipients(); <em class="jxr_comment">// matching file found</em>
+<a name="135" href="#135">135</a> } <strong class="jxr_keyword">else</strong> {
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">// no matching attachment found</em>
+<a name="137" href="#137">137</a> }
+<a name="138" href="#138">138</a>
+<a name="139" href="#139">139</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (isDebug) {
+<a name="141" href="#141">141</a> log(<span class="jxr_string">"Malformed message"</span>, e);
+<a name="142" href="#142">142</a> }
+<a name="143" href="#143">143</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Malformed message"</span>, e);
+<a name="144" href="#144">144</a> }
+<a name="145" href="#145">145</a> }
+<a name="146" href="#146">146</a>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">/**</em>
+<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * Checks if <I>part</I> matches with at least one of the <CODE>masks</CODE>.</em>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em>
+<a name="150" href="#150">150</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> matchFound(Part part) <strong class="jxr_keyword">throws</strong> Exception {
+<a name="151" href="#151">151</a>
+<a name="152" href="#152">152</a> <em class="jxr_comment">/*</em>
+<a name="153" href="#153">153</a> <em class="jxr_comment"> * if there is an attachment and no inline text,</em>
+<a name="154" href="#154">154</a> <em class="jxr_comment"> * the content type can be anything</em>
+<a name="155" href="#155">155</a> <em class="jxr_comment"> */</em>
+<a name="156" href="#156">156</a>
+<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (part.getContentType() == <strong class="jxr_keyword">null</strong> ||
+<a name="158" href="#158">158</a> part.getContentType().startsWith(<span class="jxr_string">"multipart/alternative"</span>)) {
+<a name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> false;
+<a name="160" href="#160">160</a> }
+<a name="161" href="#161">161</a>
+<a name="162" href="#162">162</a> Object content;
+<a name="163" href="#163">163</a>
+<a name="164" href="#164">164</a> <strong class="jxr_keyword">try</strong> {
+<a name="165" href="#165">165</a> content = part.getContent();
+<a name="166" href="#166">166</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException uee) {
+<a name="167" href="#167">167</a> <em class="jxr_comment">// in this case it is not an attachment, so ignore it</em>
+<a name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> false;
+<a name="169" href="#169">169</a> }
+<a name="170" href="#170">170</a>
+<a name="171" href="#171">171</a> Exception anException = <strong class="jxr_keyword">null</strong>;
+<a name="172" href="#172">172</a>
+<a name="173" href="#173">173</a> <strong class="jxr_keyword">if</strong> (content instanceof Multipart) {
+<a name="174" href="#174">174</a> Multipart multipart = (Multipart) content;
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < multipart.getCount(); i++) {
+<a name="176" href="#176">176</a> <strong class="jxr_keyword">try</strong> {
+<a name="177" href="#177">177</a> Part bodyPart = multipart.getBodyPart(i);
+<a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (matchFound(bodyPart)) {
+<a name="179" href="#179">179</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">// matching file found</em>
+<a name="180" href="#180">180</a> }
+<a name="181" href="#181">181</a> } <strong class="jxr_keyword">catch</strong> (MessagingException e) {
+<a name="182" href="#182">182</a> anException = e;
+<a name="183" href="#183">183</a> } <em class="jxr_comment">// remember any messaging exception and process next bodypart</em>
+<a name="184" href="#184">184</a> }
+<a name="185" href="#185">185</a> } <strong class="jxr_keyword">else</strong> {
+<a name="186" href="#186">186</a> String fileName = part.getFileName();
+<a name="187" href="#187">187</a> <strong class="jxr_keyword">if</strong> (fileName != <strong class="jxr_keyword">null</strong>) {
+<a name="188" href="#188">188</a> fileName = cleanFileName(fileName);
+<a name="189" href="#189">189</a> <em class="jxr_comment">// check the file name</em>
+<a name="190" href="#190">190</a> <strong class="jxr_keyword">if</strong> (matchFound(fileName)) {
+<a name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (isDebug) {
+<a name="192" href="#192">192</a> log(<span class="jxr_string">"matched "</span> + fileName);
+<a name="193" href="#193">193</a> }
+<a name="194" href="#194">194</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="195" href="#195">195</a> }
+<a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (unzipIsRequested && fileName.endsWith(ZIP_SUFFIX) && matchFoundInZip(part)){
+<a name="197" href="#197">197</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="198" href="#198">198</a> }
+<a name="199" href="#199">199</a> }
+<a name="200" href="#200">200</a> }
+<a name="201" href="#201">201</a>
+<a name="202" href="#202">202</a> <em class="jxr_comment">// if no matching attachment was found and at least one exception was catched rethrow it up</em>
+<a name="203" href="#203">203</a> <strong class="jxr_keyword">if</strong> (anException != <strong class="jxr_keyword">null</strong>) {
+<a name="204" href="#204">204</a> <strong class="jxr_keyword">throw</strong> anException;
+<a name="205" href="#205">205</a> }
+<a name="206" href="#206">206</a>
+<a name="207" href="#207">207</a> <strong class="jxr_keyword">return</strong> false;
+<a name="208" href="#208">208</a> }
+<a name="209" href="#209">209</a>
+<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">/**</em>
+<a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * Checks if <I>fileName</I> matches with at least one of the <CODE>masks</CODE>.</em>
+<a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> */</em>
+<a name="213" href="#213">213</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> matchFound(String fileName) {
+<a name="214" href="#214">214</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < masks.length; j++) {
+<a name="215" href="#215">215</a> <strong class="jxr_keyword">boolean</strong> fMatch;
+<a name="216" href="#216">216</a> <a href="../../../../../org/apache/james/transport/matchers/AttachmentFileNameIs.html">Mask</a> mask = masks[j];
+<a name="217" href="#217">217</a>
+<a name="218" href="#218">218</a> <em class="jxr_comment">//XXX: file names in mail may contain directory - theoretically</em>
+<a name="219" href="#219">219</a> <strong class="jxr_keyword">if</strong> (mask.suffixMatch) {
+<a name="220" href="#220">220</a> fMatch = fileName.endsWith(mask.matchString);
+<a name="221" href="#221">221</a> } <strong class="jxr_keyword">else</strong> {
+<a name="222" href="#222">222</a> fMatch = fileName.equals(mask.matchString);
+<a name="223" href="#223">223</a> }
+<a name="224" href="#224">224</a> <strong class="jxr_keyword">if</strong> (fMatch) {
+<a name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">// matching file found</em>
+<a name="226" href="#226">226</a> }
+<a name="227" href="#227">227</a> }
+<a name="228" href="#228">228</a> <strong class="jxr_keyword">return</strong> false;
+<a name="229" href="#229">229</a> }
+<a name="230" href="#230">230</a>
+<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">/**</em>
+<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * Checks if <I>part</I> is a zip containing a file that matches with at least one of the <CODE>masks</CODE>.</em>
+<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> */</em>
+<a name="234" href="#234">234</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> matchFoundInZip(Part part) <strong class="jxr_keyword">throws</strong> MessagingException, IOException {
+<a name="235" href="#235">235</a> ZipInputStream zis = <strong class="jxr_keyword">new</strong> ZipInputStream(part.getInputStream());
+<a name="236" href="#236">236</a>
+<a name="237" href="#237">237</a> <strong class="jxr_keyword">try</strong> {
+<a name="238" href="#238">238</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
+<a name="239" href="#239">239</a> ZipEntry zipEntry = zis.getNextEntry();
+<a name="240" href="#240">240</a> <strong class="jxr_keyword">if</strong> (zipEntry == <strong class="jxr_keyword">null</strong>) {
+<a name="241" href="#241">241</a> <strong class="jxr_keyword">break</strong>;
+<a name="242" href="#242">242</a> }
+<a name="243" href="#243">243</a> String fileName = zipEntry.getName();
+<a name="244" href="#244">244</a> <strong class="jxr_keyword">if</strong> (matchFound(fileName)) {
+<a name="245" href="#245">245</a> <strong class="jxr_keyword">if</strong> (isDebug) {
+<a name="246" href="#246">246</a> log(<span class="jxr_string">"matched "</span> + part.getFileName() + <span class="jxr_string">"("</span> + fileName + <span class="jxr_string">")"</span>);
+<a name="247" href="#247">247</a> }
+<a name="248" href="#248">248</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="249" href="#249">249</a> }
+<a name="250" href="#250">250</a> }
+<a name="251" href="#251">251</a> <strong class="jxr_keyword">return</strong> false;
+<a name="252" href="#252">252</a> } <strong class="jxr_keyword">finally</strong> {
+<a name="253" href="#253">253</a> zis.close();
+<a name="254" href="#254">254</a> }
+<a name="255" href="#255">255</a> }
+<a name="256" href="#256">256</a>
+<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">/**</em>
+<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * Transforms <I>fileName<I> in a trimmed lowercase string usable for matching agains the masks.</em>
+<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> */</em>
+<a name="260" href="#260">260</a> <strong class="jxr_keyword">protected</strong> String cleanFileName(String fileName) {
+<a name="261" href="#261">261</a> <strong class="jxr_keyword">return</strong> fileName.toLowerCase(Locale.US).trim();
+<a name="262" href="#262">262</a> }
+<a name="263" href="#263">263</a> }
+<a name="264" href="#264">264</a>
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/CommandForListserv.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/CommandForListserv.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/CommandForListserv.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/matchers/CommandForListserv.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,72 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>CommandForListserv xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/matchers/CommandForListserv.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.matchers;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericRecipientMatcher;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.MailAddress;
+<a name="26" href="#26">26</a>
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="28" href="#28">28</a>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Returns positive if the recipient is a command for a listserv. For example,</em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * if my listserv is james@list.working-dogs.com, this matcher will return true</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * for james-on@list.working-dogs.com and james-off@list.working-dogs.com.</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em>
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/matchers/CommandForListserv.html">CommandForListserv</a> <strong class="jxr_keyword">extends</strong> GenericRecipientMatcher {
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> MailAddress listservAddress;
+<a name="38" href="#38">38</a>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @see org.apache.mailet.GenericRecipientMatcher#init()</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em>
+<a name="42" href="#42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="43" href="#43">43</a> listservAddress = <strong class="jxr_keyword">new</strong> MailAddress(getCondition());
+<a name="44" href="#44">44</a> }
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @see org.apache.mailet.GenericRecipientMatcher#matchRecipient(MailAddress)</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
+<a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matchRecipient(MailAddress recipient) {
+<a name="50" href="#50">50</a> <strong class="jxr_keyword">if</strong> (recipient.getHost().equals(listservAddress.getHost())) {
+<a name="51" href="#51">51</a> <strong class="jxr_keyword">if</strong> (recipient.getUser().equals(listservAddress.getUser() + <span class="jxr_string">"-on"</span>)
+<a name="52" href="#52">52</a> || recipient.getUser().equals(listservAddress.getUser() + <span class="jxr_string">"-off"</span>)) {
+<a name="53" href="#53">53</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="54" href="#54">54</a> }
+<a name="55" href="#55">55</a> }
+<a name="56" href="#56">56</a> <strong class="jxr_keyword">return</strong> false;
+<a name="57" href="#57">57</a> }
+<a name="58" href="#58">58</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+