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 [39/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/AbstractAddFooter.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AbstractAddFooter.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AbstractAddFooter.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AbstractAddFooter.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,207 @@
+<!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>AbstractAddFooter xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/mailets/AbstractAddFooter.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;
+<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.RFC2822Headers;
+<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> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeBodyPart;
+<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> javax.mail.internet.MimeMultipart;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimePart;
+<a name="33" href="#33">33</a>
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * An abstract implementation of a mailet that add a Footer to an email</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> */</em>
+<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/mailets/AbstractAddFooter.html">AbstractAddFooter</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<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"> * Takes the message and attaches a footer message to it. Right now, it only</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * supports simple messages. Needs to have additions to make it support</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * messages with alternate content types or with attachments.</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @param mail the mail being processed</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 an error arises during message processing</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">void</strong> service(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">try</strong> {
+<a name="53" href="#53">53</a> MimeMessage message = mail.getMessage();
+<a name="54" href="#54">54</a>
+<a name="55" href="#55">55</a> <strong class="jxr_keyword">if</strong> (attachFooter(message)) {
+<a name="56" href="#56">56</a> message.saveChanges();
+<a name="57" href="#57">57</a> } <strong class="jxr_keyword">else</strong> {
+<a name="58" href="#58">58</a> log(<span class="jxr_string">"Unable to add footer to mail "</span> + mail.getName());
+<a name="59" href="#59">59</a> }
+<a name="60" href="#60">60</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
+<a name="61" href="#61">61</a> log(<span class="jxr_string">"UnsupportedEncoding Unable to add footer to mail "</span>
+<a name="62" href="#62">62</a> + mail.getName());
+<a name="63" href="#63">63</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
+<a name="64" href="#64">64</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Could not read message"</span>, ioe);
+<a name="65" href="#65">65</a> }
+<a name="66" href="#66">66</a> }
+<a name="67" href="#67">67</a>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Prepends the content of the MimePart as text to the existing footer</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param part the MimePart to attach</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> *</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @throws MessagingException</em>
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
+<a name="76" href="#76">76</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addToText(MimePart part) <strong class="jxr_keyword">throws</strong> MessagingException,
+<a name="77" href="#77">77</a> IOException {
+<a name="78" href="#78">78</a> <em class="jxr_comment">// log("Trying to add footer to " + part.getContent().toString());</em>
+<a name="79" href="#79">79</a> String contentType = part.getContentType();
+<a name="80" href="#80">80</a> String content = (String) part.getContent();
+<a name="81" href="#81">81</a>
+<a name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (!content.endsWith(<span class="jxr_string">"\n"</span>)) {
+<a name="83" href="#83">83</a> content += <span class="jxr_string">"\r\n"</span>;
+<a name="84" href="#84">84</a> }
+<a name="85" href="#85">85</a> content += getFooterText();
+<a name="86" href="#86">86</a>
+<a name="87" href="#87">87</a> part.setContent(content, contentType);
+<a name="88" href="#88">88</a> part.setHeader(RFC2822Headers.CONTENT_TYPE, contentType);
+<a name="89" href="#89">89</a> <em class="jxr_comment">// log("After adding footer: " + part.getContent().toString());</em>
+<a name="90" href="#90">90</a> }
+<a name="91" href="#91">91</a>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Prepends the content of the MimePart as HTML to the existing footer</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param part the MimePart to attach</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> *</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @throws MessagingException</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
+<a name="100" href="#100">100</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addToHTML(MimePart part) <strong class="jxr_keyword">throws</strong> MessagingException,
+<a name="101" href="#101">101</a> IOException {
+<a name="102" href="#102">102</a> <em class="jxr_comment">// log("Trying to add footer to " + part.getContent().toString());</em>
+<a name="103" href="#103">103</a> String contentType = part.getContentType();
+<a name="104" href="#104">104</a> String content = (String) part.getContent();
+<a name="105" href="#105">105</a>
+<a name="106" href="#106">106</a> <em class="jxr_comment">/*<em class="jxr_comment"> This HTML part may have a closing <BODY> tag. If so, we</em></em>
+<a name="107" href="#107">107</a> <em class="jxr_comment"> * want to insert out footer immediately prior to that tag.</em>
+<a name="108" href="#108">108</a> <em class="jxr_comment"> */</em>
+<a name="109" href="#109">109</a> <strong class="jxr_keyword">int</strong> index = content.lastIndexOf(<span class="jxr_string">"</body>"</span>);
+<a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (index == -1)
+<a name="111" href="#111">111</a> index = content.lastIndexOf(<span class="jxr_string">"</BODY>"</span>);
+<a name="112" href="#112">112</a> String insert = <span class="jxr_string">"<br>"</span> + getFooterHTML();
+<a name="113" href="#113">113</a> content = index == -1 ? content + insert : content.substring(0, index)
+<a name="114" href="#114">114</a> + insert + content.substring(index);
+<a name="115" href="#115">115</a>
+<a name="116" href="#116">116</a> part.setContent(content, contentType);
+<a name="117" href="#117">117</a> part.setHeader(RFC2822Headers.CONTENT_TYPE, contentType);
+<a name="118" href="#118">118</a> <em class="jxr_comment">// log("After adding footer: " + part.getContent().toString());</em>
+<a name="119" href="#119">119</a> }
+<a name="120" href="#120">120</a>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">/**</em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * Attach a footer a MimePart</em>
+<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> *</em>
+<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param part the MimePart to which the footer is to be attached</em>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> *</em>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @return whether a footer was successfully attached</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @throws MessagingException</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
+<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em>
+<a name="130" href="#130">130</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> attachFooter(MimePart part) <strong class="jxr_keyword">throws</strong> MessagingException,
+<a name="131" href="#131">131</a> IOException {
+<a name="132" href="#132">132</a> <em class="jxr_comment">// log("Content type is " + part.getContentType());</em>
+<a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> (part.isMimeType(<span class="jxr_string">"text/plain"</span>)
+<a name="134" href="#134">134</a> && part.getContent() instanceof String) {
+<a name="135" href="#135">135</a> addToText(part);
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="137" href="#137">137</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (part.isMimeType(<span class="jxr_string">"text/html"</span>)
+<a name="138" href="#138">138</a> && part.getContent() instanceof String) {
+<a name="139" href="#139">139</a> addToHTML(part);
+<a name="140" href="#140">140</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="141" href="#141">141</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (part.isMimeType(<span class="jxr_string">"multipart/mixed"</span>)
+<a name="142" href="#142">142</a> || part.isMimeType(<span class="jxr_string">"multipart/related"</span>)) {
+<a name="143" href="#143">143</a> <em class="jxr_comment">//Find the first body part, and determine what to do then.</em>
+<a name="144" href="#144">144</a> MimeMultipart multipart = (MimeMultipart) part.getContent();
+<a name="145" href="#145">145</a> MimeBodyPart firstPart = (MimeBodyPart) multipart.getBodyPart(0);
+<a name="146" href="#146">146</a> <strong class="jxr_keyword">boolean</strong> isFooterAttached = attachFooter(firstPart);
+<a name="147" href="#147">147</a> <strong class="jxr_keyword">if</strong> (isFooterAttached) {
+<a name="148" href="#148">148</a> <em class="jxr_comment">//We have to do this because of a bug in JavaMail (ref id 4403733)</em>
+<a name="149" href="#149">149</a> <em class="jxr_comment">//http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4403733</em>
+<a name="150" href="#150">150</a> part.setContent(multipart);
+<a name="151" href="#151">151</a> }
+<a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> isFooterAttached;
+<a name="153" href="#153">153</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (part.isMimeType(<span class="jxr_string">"multipart/alternative"</span>)) {
+<a name="154" href="#154">154</a> MimeMultipart multipart = (MimeMultipart) part.getContent();
+<a name="155" href="#155">155</a> <strong class="jxr_keyword">int</strong> count = multipart.getCount();
+<a name="156" href="#156">156</a> <em class="jxr_comment">// log("number of alternatives = " + count);</em>
+<a name="157" href="#157">157</a> <strong class="jxr_keyword">boolean</strong> isFooterAttached = false;
+<a name="158" href="#158">158</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> index = 0; index < count; index++) {
+<a name="159" href="#159">159</a> <em class="jxr_comment">// log("processing alternative #" + index);</em>
+<a name="160" href="#160">160</a> MimeBodyPart mimeBodyPart = (MimeBodyPart) multipart
+<a name="161" href="#161">161</a> .getBodyPart(index);
+<a name="162" href="#162">162</a> isFooterAttached |= attachFooter(mimeBodyPart);
+<a name="163" href="#163">163</a> }
+<a name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (isFooterAttached) {
+<a name="165" href="#165">165</a> <em class="jxr_comment">//We have to do this because of a bug in JavaMail (ref id 4403733)</em>
+<a name="166" href="#166">166</a> <em class="jxr_comment">//http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4403733</em>
+<a name="167" href="#167">167</a> part.setContent(multipart);
+<a name="168" href="#168">168</a> }
+<a name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> isFooterAttached;
+<a name="170" href="#170">170</a> } <strong class="jxr_keyword">else</strong> {
+<a name="171" href="#171">171</a> <em class="jxr_comment">//Give up... we won't attach the footer to this MimePart</em>
+<a name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> false;
+<a name="173" href="#173">173</a> }
+<a name="174" href="#174">174</a> }
+<a name="175" href="#175">175</a>
+<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">/**</em>
+<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * This is exposed as a method for easy subclassing to provide alternate ways</em>
+<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * to get the footer text.</em>
+<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> *</em>
+<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * @return the footer text</em>
+<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> */</em>
+<a name="182" href="#182">182</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getFooterText();
+<a name="183" href="#183">183</a>
+<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">/**</em>
+<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * This is exposed as a method for easy subclassing to provide alternate ways</em>
+<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * to get the footer text. By default, this will take the footer text,</em>
+<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * converting the linefeeds to &lt;br&gt; tags.</em>
+<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> *</em>
+<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @return the HTML version of the footer text</em>
+<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em>
+<a name="191" href="#191">191</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getFooterHTML();
+<a name="192" href="#192">192</a>
+<a name="193" href="#193">193</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/AddFooter.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddFooter.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddFooter.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddFooter.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,102 @@
+<!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>AddFooter xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/mailets/AddFooter.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;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.StringTokenizer;
+<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"> * This mailet will attach text to the end of the message (like a footer). Right</em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * now it only supports simple messages without multiple parts.</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/AddFooter.html">AddFooter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/james/transport/mailets/AbstractAddFooter.html">AbstractAddFooter</a> {
+<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"> * This is the plain text version of the footer we are going to add</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
+<a name="36" href="#36">36</a> String text = <span class="jxr_string">""</span>;
+<a name="37" href="#37">37</a>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * Initialize the mailet</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="42" href="#42">42</a> text = getInitParameter(<span class="jxr_string">"text"</span>);
+<a name="43" href="#43">43</a> }
+<a name="44" href="#44">44</a>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * This is exposed as a method for easy subclassing to provide alternate ways</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * to get the footer text.</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> *</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @return the footer text</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> String getFooterText() {
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">return</strong> text;
+<a name="53" href="#53">53</a> }
+<a name="54" href="#54">54</a>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * This is exposed as a method for easy subclassing to provide alternate ways</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * to get the footer text. By default, this will take the footer text,</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * converting the linefeeds to &lt;br&gt; tags.</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @return the HTML version of the footer text</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em>
+<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> String getFooterHTML() {
+<a name="63" href="#63">63</a> String text = getFooterText();
+<a name="64" href="#64">64</a> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="65" href="#65">65</a> StringTokenizer st = <strong class="jxr_keyword">new</strong> StringTokenizer(text, <span class="jxr_string">"\r\n"</span>, <strong class="jxr_keyword">true</strong>);
+<a name="66" href="#66">66</a> <strong class="jxr_keyword">while</strong> (st.hasMoreTokens()) {
+<a name="67" href="#67">67</a> String token = st.nextToken();
+<a name="68" href="#68">68</a> <strong class="jxr_keyword">if</strong> (token.equals(<span class="jxr_string">"\r"</span>)) {
+<a name="69" href="#69">69</a> <strong class="jxr_keyword">continue</strong>;
+<a name="70" href="#70">70</a> }
+<a name="71" href="#71">71</a> <strong class="jxr_keyword">if</strong> (token.equals(<span class="jxr_string">"\n"</span>)) {
+<a name="72" href="#72">72</a> sb.append(<span class="jxr_string">"<br />\n"</span>);
+<a name="73" href="#73">73</a> } <strong class="jxr_keyword">else</strong> {
+<a name="74" href="#74">74</a> sb.append(token);
+<a name="75" href="#75">75</a> }
+<a name="76" href="#76">76</a> }
+<a name="77" href="#77">77</a> <strong class="jxr_keyword">return</strong> sb.toString();
+<a name="78" href="#78">78</a> }
+<a name="79" href="#79">79</a>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Return a string describing this mailet.</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> *</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @return a string describing this mailet</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> */</em>
+<a name="85" href="#85">85</a> <strong class="jxr_keyword">public</strong> String getMailetInfo() {
+<a name="86" href="#86">86</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"AddFooter Mailet"</span>;
+<a name="87" href="#87">87</a> }
+<a name="88" href="#88">88</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/AddHabeasWarrantMark.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddHabeasWarrantMark.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddHabeasWarrantMark.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddHabeasWarrantMark.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,133 @@
+<!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>AddHabeasWarrantMark xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/mailets/AddHabeasWarrantMark.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;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.james.transport.matchers.HasHabeasWarrantMark;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet ;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail ;
+<a name="27" href="#27">27</a>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * This matcher adds the Hebeas Warrant Mark to a message.</em>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * For details see: <a href="http://www.hebeas.com" target="alexandria_uri">http://www.hebeas.com</a></em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> *</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Usage: <mailet match="<suitable-matcher>" class="AddHabeasWarrantMark" /></em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * NOTE: Although this mailet is covered by the Apache Software License,</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * the Habeas Warrant Mark is copyright. A separate license from Habeas</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * is required in order to legally attach the Habeas Warrant Mark to</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * e-mail messages. Each James Administrator is responsible for</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * ensuring that James is configured to attach the Habeas Warrant Mark</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * only to e-mail covered by a suitable license received from Habeas.</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * </em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Because the Habeas Warrant Mark is copyright material, I have asked</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * for and received the following explicit statement from Habeas:</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * -----------------------------------</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * From: Lindsey Pettit [<a href="mailto:support@habeas.com" target="alexandria_uri">mailto:support@habeas.com</a>]</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Sent: Sunday, September 29, 2002 5:51</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * To: Noel J. Bergman</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Subject: RE: Habeas and Apache James</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> *</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Dear Noel,</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * > FURTHERMORE, if James is to be capable of sending Habeas SWE, I need</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * > to write a Mailet that attaches the headers. As with any MTA, it</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * > would be up to the administrator to properly configure James and make</em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * > sure that licenses are acquired. Since the Habeas Warrant Mark is</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * > copyright, I believe that I require authorization from you for that</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * > Mailet, especially since it attaches the Habeas Warrant Mark. For my</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * > own protection, please show me why such authorization is unnecessary,</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * > send me a digitally signed e-mail, or FAX a signed authorization</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * </em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * You do not yourself need the authorization to build the functionality </em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * into the [mailet]; what one needs authorization, in the form of a </em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * license, for, is to use the mark *in headers*, in outgoing email.</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * However, please let me know if you would like something more </em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * formal, and I can try to have something faxed to you.</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * </em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * > The Mailet docs would reference the Habeas website, and inform</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * > administrators that in order to USE the mailet, they need to ensure</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * > that they have whatever licenses are required from you as appropriate</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * > to your licensing terms.</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * That's absolutely perfect!</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * -----------------------------------</em>
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> *</em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
+<a name="76" href="#76">76</a>
+<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/mailets/AddHabeasWarrantMark.html">AddHabeasWarrantMark</a> <strong class="jxr_keyword">extends</strong> GenericMailet
+<a name="78" href="#78">78</a> {
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Called by the mailet container to allow the mailet to process to</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * a message message.</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> *</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * This method adds the Habeas Warrant Mark headers to the message,</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * saves the changes, and then allows the message to fall through</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * in the pipeline.</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> *</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @param mail - the Mail object that contains the message and routing information</em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @throws javax.mail.MessagingException - if an message or address parsing exception occurs or</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * an exception that interferes with the mailet's normal operation</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> service(Mail mail) <strong class="jxr_keyword">throws</strong> javax.mail.MessagingException
+<a name="92" href="#92">92</a> {
+<a name="93" href="#93">93</a> <strong class="jxr_keyword">try</strong>
+<a name="94" href="#94">94</a> {
+<a name="95" href="#95">95</a> javax.mail.internet.MimeMessage message = mail.getMessage();
+<a name="96" href="#96">96</a>
+<a name="97" href="#97">97</a> <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">int</strong> i = 0 ; i < HasHabeasWarrantMark.warrantMark.length ; i++)
+<a name="98" href="#98">98</a> {
+<a name="99" href="#99">99</a> message.setHeader(HasHabeasWarrantMark.warrantMark[i][0], HasHabeasWarrantMark.warrantMark[i][1]);
+<a name="100" href="#100">100</a> }
+<a name="101" href="#101">101</a>
+<a name="102" href="#102">102</a> message.saveChanges();
+<a name="103" href="#103">103</a> }
+<a name="104" href="#104">104</a> <strong class="jxr_keyword">catch</strong> (javax.mail.MessagingException me)
+<a name="105" href="#105">105</a> {
+<a name="106" href="#106">106</a> log(me.getMessage());
+<a name="107" href="#107">107</a> }
+<a name="108" href="#108">108</a> }
+<a name="109" href="#109">109</a>
+<a name="110" href="#110">110</a> <em class="jxr_comment">/*</em>
+<a name="111" href="#111">111</a> <em class="jxr_comment"> * Return a string describing this mailet.</em>
+<a name="112" href="#112">112</a> <em class="jxr_comment"> *</em>
+<a name="113" href="#113">113</a> <em class="jxr_comment"> * @return a string describing this mailet</em>
+<a name="114" href="#114">114</a> <em class="jxr_comment"> */</em>
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> String getMailetInfo()
+<a name="116" href="#116">116</a> {
+<a name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Add Habeas Warrant Mark. Must be used in accordance with a license from Habeas (see http://www.habeas.com for details)."</span>;
+<a name="118" href="#118">118</a> }
+<a name="119" href="#119">119</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/AddSubjectPrefix.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddSubjectPrefix.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddSubjectPrefix.html (added)
+++ james/site/trunk/www/mailet/standard/xref/org/apache/james/transport/mailets/AddSubjectPrefix.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,166 @@
+<!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>AddSubjectPrefix xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/james/transport/mailets/AddSubjectPrefix.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;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage;
+<a name="26" href="#26">26</a>
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.RFC2822Headers;
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Add an prefix (tag) to the subject of a message <br></em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <br></em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Sample Configuration: <br></em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <br></em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * &lt;mailet match="RecipientIs=robot@james.apache.org" class="TagMessage"&gt;</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * &lt;subjectPrefix&gt;[robot]&lt;/subjectPrefix&gt; &lt;/mailet&gt; <br></em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <br></em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/james/transport/mailets/AddSubjectPrefix.html">AddSubjectPrefix</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<a name="42" href="#42">42</a>
+<a name="43" href="#43">43</a> <em class="jxr_comment">// prefix to add</em>
+<a name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> String subjectPrefix = <strong class="jxr_keyword">null</strong>;
+<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"> * Initialize the mailet.</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">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="50" href="#50">50</a> subjectPrefix = getInitParameter(<span class="jxr_string">"subjectPrefix"</span>);
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">if</strong> (subjectPrefix == <strong class="jxr_keyword">null</strong> || subjectPrefix.equals(<span class="jxr_string">""</span>)) {
+<a name="53" href="#53">53</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(
+<a name="54" href="#54">54</a> <span class="jxr_string">"Please configure a valid subjectPrefix"</span>);
+<a name="55" href="#55">55</a> }
+<a name="56" href="#56">56</a> }
+<a name="57" href="#57">57</a>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Takes the message and adds a prefix to the subject</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * </em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param mail</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * the mail being processed</em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * </em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @throws MessagingException</em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * if an error arises during message processing</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
+<a name="67" href="#67">67</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="68" href="#68">68</a> String newSubject = <strong class="jxr_keyword">null</strong>;
+<a name="69" href="#69">69</a> MimeMessage m = mail.getMessage();
+<a name="70" href="#70">70</a>
+<a name="71" href="#71">71</a> String subject = m.getSubject();
+<a name="72" href="#72">72</a>
+<a name="73" href="#73">73</a> <strong class="jxr_keyword">if</strong> (subject != <strong class="jxr_keyword">null</strong>) {
+<a name="74" href="#74">74</a> <em class="jxr_comment">// m.setSubject(subjectPrefix + " " + subject);</em>
+<a name="75" href="#75">75</a> newSubject = subjectPrefix + <span class="jxr_string">" "</span> + m.getSubject().toString();
+<a name="76" href="#76">76</a>
+<a name="77" href="#77">77</a> } <strong class="jxr_keyword">else</strong> {
+<a name="78" href="#78">78</a> newSubject = subjectPrefix;
+<a name="79" href="#79">79</a> }
+<a name="80" href="#80">80</a>
+<a name="81" href="#81">81</a> <em class="jxr_comment">/*</em>
+<a name="82" href="#82">82</a> <em class="jxr_comment"> * Get sure to use the right encoding when add the subjectPrefix..</em>
+<a name="83" href="#83">83</a> <em class="jxr_comment"> * otherwise we get problems with some special chars</em>
+<a name="84" href="#84">84</a> <em class="jxr_comment"> */</em>
+<a name="85" href="#85">85</a> String rawSubject = m.getHeader(RFC2822Headers.SUBJECT, <strong class="jxr_keyword">null</strong>);
+<a name="86" href="#86">86</a> String mimeCharset = determineMailHeaderEncodingCharset(rawSubject);
+<a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (mimeCharset == <strong class="jxr_keyword">null</strong>) { <em class="jxr_comment">// most likely ASCII</em>
+<a name="88" href="#88">88</a> <em class="jxr_comment">// it uses the system charset or the value of the</em>
+<a name="89" href="#89">89</a> <em class="jxr_comment">// mail.mime.charset property if set</em>
+<a name="90" href="#90">90</a> m.setSubject(newSubject);
+<a name="91" href="#91">91</a> <strong class="jxr_keyword">return</strong>;
+<a name="92" href="#92">92</a> } <strong class="jxr_keyword">else</strong> { <em class="jxr_comment">// original charset determined</em>
+<a name="93" href="#93">93</a> String javaCharset = javax.mail.internet.MimeUtility
+<a name="94" href="#94">94</a> .javaCharset(mimeCharset);
+<a name="95" href="#95">95</a> <strong class="jxr_keyword">try</strong> {
+<a name="96" href="#96">96</a> m.setSubject(newSubject, javaCharset);
+<a name="97" href="#97">97</a> } <strong class="jxr_keyword">catch</strong> (MessagingException e) {
+<a name="98" href="#98">98</a> <em class="jxr_comment">// known, but unsupported encoding</em>
+<a name="99" href="#99">99</a> <em class="jxr_comment">// this should be logged, the admin may setup a more i18n</em>
+<a name="100" href="#100">100</a> <em class="jxr_comment">// capable JRE, but the log API cannot be accessed from here</em>
+<a name="101" href="#101">101</a> <em class="jxr_comment">// if (charset != null) log(charset +</em>
+<a name="102" href="#102">102</a> <em class="jxr_comment">// " charset unsupported by the JRE, email subject may be</em>
+<a name="103" href="#103">103</a> <em class="jxr_comment">// damaged");</em>
+<a name="104" href="#104">104</a> m.setSubject(newSubject); <em class="jxr_comment">// recover</em>
+<a name="105" href="#105">105</a> }
+<a name="106" href="#106">106</a> }
+<a name="107" href="#107">107</a> m.saveChanges();
+<a name="108" href="#108">108</a> }
+<a name="109" href="#109">109</a>
+<a name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> String getMailetInfo() {
+<a name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"AddSubjectPrefix Mailet"</span>;
+<a name="112" href="#112">112</a> }
+<a name="113" href="#113">113</a>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em>
+<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * It attempts to determine the charset used to encode an "unstructured" RFC</em>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * 822 header (like Subject). The encoding is specified in RFC 2047. If it</em>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * cannot determine or the the text is not encoded then it returns null.</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * </em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Here is an example raw text: Subject:</em>
+<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * =?iso-8859-2?Q?leg=FAjabb_pr=F3ba_l=F5elemmel?=</em>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * </em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * TODO: Should we include this in a util class ?</em>
+<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * </em>
+<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param rawText</em>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * the raw (not decoded) value of the header. Null means that the</em>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * header was not present (in this case it always return null).</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @return the MIME charset name or null if no encoding applied</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em>
+<a name="129" href="#129">129</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">private</strong> String determineMailHeaderEncodingCharset(String rawText) {
+<a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (rawText == <strong class="jxr_keyword">null</strong>)
+<a name="131" href="#131">131</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="132" href="#132">132</a> <strong class="jxr_keyword">int</strong> iEncodingPrefix = rawText.indexOf(<span class="jxr_string">"=?"</span>);
+<a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> (iEncodingPrefix == -1)
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">int</strong> iCharsetBegin = iEncodingPrefix + 2;
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">int</strong> iSecondQuestionMark = rawText.indexOf('?', iCharsetBegin);
+<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (iSecondQuestionMark == -1)
+<a name="138" href="#138">138</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="139" href="#139">139</a> <em class="jxr_comment">// safety checks</em>
+<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (iSecondQuestionMark == iCharsetBegin)
+<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">// empty charset? impossible</em>
+<a name="142" href="#142">142</a> <strong class="jxr_keyword">int</strong> iThirdQuestionMark = rawText.indexOf('?', iSecondQuestionMark + 1);
+<a name="143" href="#143">143</a> <strong class="jxr_keyword">if</strong> (iThirdQuestionMark == -1)
+<a name="144" href="#144">144</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">// there must be one after encoding</em>
+<a name="145" href="#145">145</a> <strong class="jxr_keyword">if</strong> (-1 == rawText.indexOf(<span class="jxr_string">"?="</span>, iThirdQuestionMark + 1))
+<a name="146" href="#146">146</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">// closing tag</em>
+<a name="147" href="#147">147</a> String mimeCharset = rawText.substring(iCharsetBegin,
+<a name="148" href="#148">148</a> iSecondQuestionMark);
+<a name="149" href="#149">149</a> <strong class="jxr_keyword">return</strong> mimeCharset;
+<a name="150" href="#150">150</a> }
+<a name="151" href="#151">151</a>
+<a name="152" href="#152">152</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+