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 da...@apache.org on 2007/05/08 17:59:37 UTC
svn commit: r536230 [15/17] - in /james/site/trunk/www: ./ mailet/
mailet/apidocs/ mailet/apidocs/org/ mailet/apidocs/org/apache/
mailet/apidocs/org/apache/mailet/ mailet/apidocs/org/apache/mailet/class-use/
mailet/apidocs/org/apache/mailet/dates/ mail...
Added: james/site/trunk/www/mailet/xref/org/apache/mailet/Mailet.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/xref/org/apache/mailet/Mailet.html?view=auto&rev=536230
==============================================================================
--- james/site/trunk/www/mailet/xref/org/apache/mailet/Mailet.html (added)
+++ james/site/trunk/www/mailet/xref/org/apache/mailet/Mailet.html Tue May 8 08:59:25 2007
@@ -0,0 +1,135 @@
+<!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>Mailet xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../apidocs/org/apache/mailet/Mailet.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em>/**<em>***************************************************************</em></em>
+<a name="2" href="#2">2</a> <em> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em> * *</em>
+<a name="10" href="#10">10</a> <em> * <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> * *</em>
+<a name="12" href="#12">12</a> <em> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em> * under the License. *</em>
+<a name="18" href="#18">18</a> <em> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong>package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <em>/**<em>*</em></em>
+<a name="24" href="#24">24</a> <em> * Draft of a Mailet inteface. The <code>service</code> perform all needed work</em>
+<a name="25" href="#25">25</a> <em> * on the Mail object. Whatever remains at the end of the service is considered</em>
+<a name="26" href="#26">26</a> <em> * to need futher processing and will go to the next Mailet if there is one</em>
+<a name="27" href="#27">27</a> <em> * configured or will go to the error processor if not.</em>
+<a name="28" href="#28">28</a> <em> * Setting a Mail state (setState(String)) to Mail.GHOST or cleaning its recipient</em>
+<a name="29" href="#29">29</a> <em> * list has the same meaning that s no more processing is needed.</em>
+<a name="30" href="#30">30</a> <em> * Instead of creating new messages, the mailet can put a message with new recipients</em>
+<a name="31" href="#31">31</a> <em> * at the top of the mail queue, or insert them immediately after it's execution</em>
+<a name="32" href="#32">32</a> <em> * through the API are provided by the MailetContext interface.</em>
+<a name="33" href="#33">33</a> <em> * <p></em>
+<a name="34" href="#34">34</a> <em> * This interface defines methods to initialize a mailet, to service messages, and to</em>
+<a name="35" href="#35">35</a> <em> * remove a mailet from the server. These are known as life-cycle methods and are called</em>
+<a name="36" href="#36">36</a> <em> * in the following sequence:</em>
+<a name="37" href="#37">37</a> <em> * <ol></em>
+<a name="38" href="#38">38</a> <em> * <li>The mailet is constructed, then initialized with the init method. </li></em>
+<a name="39" href="#39">39</a> <em> * <li>Any messages for the service method are handled.</li></em>
+<a name="40" href="#40">40</a> <em> * <li>The mailet is taken out of service, then destroyed with the destroy method,</em>
+<a name="41" href="#41">41</a> <em> * then garbage collected and finalized.</li></em>
+<a name="42" href="#42">42</a> <em> * </ol></em>
+<a name="43" href="#43">43</a> <em> * In addition to the life-cycle methods, this interface provides the getMailetConfig</em>
+<a name="44" href="#44">44</a> <em> * method, which the mailet can use to get any startup information, and the</em>
+<a name="45" href="#45">45</a> <em> * getMailetInfo method, which allows the mailet to return basic information about itself,</em>
+<a name="46" href="#46">46</a> <em> * such as author, version, and copyright.</em>
+<a name="47" href="#47">47</a> <em> *</em>
+<a name="48" href="#48">48</a> <em> * @version 1.0.0, 24/04/1999</em>
+<a name="49" href="#49">49</a> <em> */</em>
+<a name="50" href="#50">50</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/apache/mailet/Mailet.html">Mailet</a> {
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <em>/**<em>*</em></em>
+<a name="53" href="#53">53</a> <em> * Called by the mailet container to indicate to a mailet that the</em>
+<a name="54" href="#54">54</a> <em> * mailet is being taken out of service. This method is only called once</em>
+<a name="55" href="#55">55</a> <em> * all threads within the mailet's service method have exited or after a</em>
+<a name="56" href="#56">56</a> <em> * timeout period has passed. After the mailet container calls this method,</em>
+<a name="57" href="#57">57</a> <em> * it will not call the service method again on this mailet.</em>
+<a name="58" href="#58">58</a> <em> * <p></em>
+<a name="59" href="#59">59</a> <em> * This method gives the mailet an opportunity to clean up any resources that</em>
+<a name="60" href="#60">60</a> <em> * are being held (for example, memory, file handles, threads) and make sure</em>
+<a name="61" href="#61">61</a> <em> * that any persistent state is synchronized with the mailet's current state in memory.</em>
+<a name="62" href="#62">62</a> <em> */</em>
+<a name="63" href="#63">63</a> <strong>void</strong> destroy();
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <em>/**<em>*</em></em>
+<a name="66" href="#66">66</a> <em> * Returns information about the mailet, such as author, version, and</em>
+<a name="67" href="#67">67</a> <em> * copyright.</em>
+<a name="68" href="#68">68</a> <em> * <p></em>
+<a name="69" href="#69">69</a> <em> * The string that this method returns should be plain text and not markup</em>
+<a name="70" href="#70">70</a> <em> * of any kind (such as HTML, XML, etc.).</em>
+<a name="71" href="#71">71</a> <em> *</em>
+<a name="72" href="#72">72</a> <em> * @return a String containing servlet information</em>
+<a name="73" href="#73">73</a> <em> */</em>
+<a name="74" href="#74">74</a> String getMailetInfo();
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> <em>/**<em>*</em></em>
+<a name="77" href="#77">77</a> <em> * Returns a MailetConfig object, which contains initialization and</em>
+<a name="78" href="#78">78</a> <em> * startup parameters for this mailet.</em>
+<a name="79" href="#79">79</a> <em> * <p></em>
+<a name="80" href="#80">80</a> <em> * Implementations of this interface are responsible for storing the MailetConfig</em>
+<a name="81" href="#81">81</a> <em> * object so that this method can return it. The GenericMailet class, which implements</em>
+<a name="82" href="#82">82</a> <em> * this interface, already does this.</em>
+<a name="83" href="#83">83</a> <em> *</em>
+<a name="84" href="#84">84</a> <em> * @return the MailetConfig object that initializes this mailet</em>
+<a name="85" href="#85">85</a> <em> */</em>
+<a name="86" href="#86">86</a> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> getMailetConfig();
+<a name="87" href="#87">87</a>
+<a name="88" href="#88">88</a> <em>/**<em>*</em></em>
+<a name="89" href="#89">89</a> <em> * Called by the mailet container to indicate to a mailet that the</em>
+<a name="90" href="#90">90</a> <em> * mailet is being placed into service.</em>
+<a name="91" href="#91">91</a> <em> * <p></em>
+<a name="92" href="#92">92</a> <em> * The mailet container calls the init method exactly once after</em>
+<a name="93" href="#93">93</a> <em> * instantiating the mailet. The init method must complete successfully</em>
+<a name="94" href="#94">94</a> <em> * before the mailet can receive any requests.</em>
+<a name="95" href="#95">95</a> <em> *</em>
+<a name="96" href="#96">96</a> <em> * @param config - a MailetConfig object containing the mailet's configuration</em>
+<a name="97" href="#97">97</a> <em> * and initialization parameters</em>
+<a name="98" href="#98">98</a> <em> * @throws javax.mail.MessagingException - if an exception has occurred that interferes with</em>
+<a name="99" href="#99">99</a> <em> * the mailet's normal operation</em>
+<a name="100" href="#100">100</a> <em> */</em>
+<a name="101" href="#101">101</a> <strong>void</strong> init(<a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> config) throws javax.mail.MessagingException;
+<a name="102" href="#102">102</a>
+<a name="103" href="#103">103</a> <em>/**<em>*</em></em>
+<a name="104" href="#104">104</a> <em> * Called by the mailet container to allow the mailet to process to</em>
+<a name="105" href="#105">105</a> <em> * a message.</em>
+<a name="106" href="#106">106</a> <em> * <p></em>
+<a name="107" href="#107">107</a> <em> * This method is only called after the mailet's init() method has completed</em>
+<a name="108" href="#108">108</a> <em> * successfully.</em>
+<a name="109" href="#109">109</a> <em> * <p></em>
+<a name="110" href="#110">110</a> <em> * Mailets typically run inside multithreaded mailet containers that can handle</em>
+<a name="111" href="#111">111</a> <em> * multiple requests concurrently. Developers must be aware to synchronize access</em>
+<a name="112" href="#112">112</a> <em> * to any shared resources such as files, network connections, as well as the</em>
+<a name="113" href="#113">113</a> <em> * mailet's class and instance variables. More information on multithreaded</em>
+<a name="114" href="#114">114</a> <em> * programming in Java is available in <a href="<a href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html" target="alexandria_uri">http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html</a>">the</em>
+<a name="115" href="#115">115</a> <em> * Java tutorial on multi-threaded programming</a>.</em>
+<a name="116" href="#116">116</a> <em> *</em>
+<a name="117" href="#117">117</a> <em> * @param mail - the Mail object that contains the message and routing information</em>
+<a name="118" href="#118">118</a> <em> * @throws javax.mail.MessagingException - if a message or address parsing exception occurs or</em>
+<a name="119" href="#119">119</a> <em> * an exception that interferes with the mailet's normal operation</em>
+<a name="120" href="#120">120</a> <em> */</em>
+<a name="121" href="#121">121</a> <strong>void</strong> service(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail) throws javax.mail.MessagingException;
+<a name="122" href="#122">122</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/xref/org/apache/mailet/MailetConfig.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/xref/org/apache/mailet/MailetConfig.html?view=auto&rev=536230
==============================================================================
--- james/site/trunk/www/mailet/xref/org/apache/mailet/MailetConfig.html (added)
+++ james/site/trunk/www/mailet/xref/org/apache/mailet/MailetConfig.html Tue May 8 08:59:25 2007
@@ -0,0 +1,87 @@
+<!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>MailetConfig xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../apidocs/org/apache/mailet/MailetConfig.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em>/**<em>***************************************************************</em></em>
+<a name="2" href="#2">2</a> <em> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em> * *</em>
+<a name="10" href="#10">10</a> <em> * <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> * *</em>
+<a name="12" href="#12">12</a> <em> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em> * under the License. *</em>
+<a name="18" href="#18">18</a> <em> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong>package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong>import</strong> java.util.Iterator;
+<a name="24" href="#24">24</a>
+<a name="25" href="#25">25</a> <em>/**<em>*</em></em>
+<a name="26" href="#26">26</a> <em> * A mailet configuration object used by a mailet container to pass information</em>
+<a name="27" href="#27">27</a> <em> * to a mailet during initialization.</em>
+<a name="28" href="#28">28</a> <em> * <p></em>
+<a name="29" href="#29">29</a> <em> * The configuration information contains initialization parameters, which are a set</em>
+<a name="30" href="#30">30</a> <em> * of name/value pairs, and a MailetContext object, which gives the mailet information</em>
+<a name="31" href="#31">31</a> <em> * about the server.</em>
+<a name="32" href="#32">32</a> <em> *</em>
+<a name="33" href="#33">33</a> <em> * @version 1.0.0, 24/04/1999</em>
+<a name="34" href="#34">34</a> <em> */</em>
+<a name="35" href="#35">35</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> {
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <em>/**<em>*</em></em>
+<a name="38" href="#38">38</a> <em> * Returns a String containing the value of the named initialization</em>
+<a name="39" href="#39">39</a> <em> * parameter, or null if the parameter does not exist.</em>
+<a name="40" href="#40">40</a> <em> *</em>
+<a name="41" href="#41">41</a> <em> * @param name - a String specifying the name of the initialization parameter</em>
+<a name="42" href="#42">42</a> <em> * @return a String containing the value of the initialization parameter</em>
+<a name="43" href="#43">43</a> <em> */</em>
+<a name="44" href="#44">44</a> String getInitParameter(String name);
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em>/**<em>*</em></em>
+<a name="47" href="#47">47</a> <em> * Returns the names of the mailet's initialization parameters as an</em>
+<a name="48" href="#48">48</a> <em> * Iterator of String objects, or an empty Iterator if the mailet has</em>
+<a name="49" href="#49">49</a> <em> * no initialization parameters.</em>
+<a name="50" href="#50">50</a> <em> *</em>
+<a name="51" href="#51">51</a> <em> * @return an Iterator of String objects containing the names of the mailet's</em>
+<a name="52" href="#52">52</a> <em> * initialization parameters</em>
+<a name="53" href="#53">53</a> <em> */</em>
+<a name="54" href="#54">54</a> Iterator getInitParameterNames();
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</a> <em>/**<em>*</em></em>
+<a name="57" href="#57">57</a> <em> * Returns a reference to the MailetContext in which the mailet is</em>
+<a name="58" href="#58">58</a> <em> * executing.</em>
+<a name="59" href="#59">59</a> <em> *</em>
+<a name="60" href="#60">60</a> <em> * @return a MailetContext object, used by the mailet to interact with its</em>
+<a name="61" href="#61">61</a> <em> * mailet container</em>
+<a name="62" href="#62">62</a> <em> */</em>
+<a name="63" href="#63">63</a> <a href="../../../org/apache/mailet/MailetContext.html">MailetContext</a> getMailetContext();
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <em>/**<em>*</em></em>
+<a name="66" href="#66">66</a> <em> * Returns the name of this mailet instance. The name may be provided via</em>
+<a name="67" href="#67">67</a> <em> * server administration, assigned in the application deployment descriptor,</em>
+<a name="68" href="#68">68</a> <em> * or for an unregistered (and thus unnamed) mailet instance it will be the</em>
+<a name="69" href="#69">69</a> <em> * mailet's class name.</em>
+<a name="70" href="#70">70</a> <em> *</em>
+<a name="71" href="#71">71</a> <em> * @return the name of the mailet instance</em>
+<a name="72" href="#72">72</a> <em> */</em>
+<a name="73" href="#73">73</a> String getMailetName();
+<a name="74" href="#74">74</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/xref/org/apache/mailet/MailetContext.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/xref/org/apache/mailet/MailetContext.html?view=auto&rev=536230
==============================================================================
--- james/site/trunk/www/mailet/xref/org/apache/mailet/MailetContext.html (added)
+++ james/site/trunk/www/mailet/xref/org/apache/mailet/MailetContext.html Tue May 8 08:59:25 2007
@@ -0,0 +1,302 @@
+<!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>MailetContext xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../apidocs/org/apache/mailet/MailetContext.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em>/**<em>***************************************************************</em></em>
+<a name="2" href="#2">2</a> <em> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em> * *</em>
+<a name="10" href="#10">10</a> <em> * <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> * *</em>
+<a name="12" href="#12">12</a> <em> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em> * under the License. *</em>
+<a name="18" href="#18">18</a> <em> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong>package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong>import</strong> java.util.Collection;
+<a name="24" href="#24">24</a> <strong>import</strong> java.util.Iterator;
+<a name="25" href="#25">25</a>
+<a name="26" href="#26">26</a> <strong>import</strong> javax.mail.MessagingException;
+<a name="27" href="#27">27</a> <strong>import</strong> javax.mail.internet.MimeMessage;
+<a name="28" href="#28">28</a>
+<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
+<a name="30" href="#30">30</a> <em> * Defines a set of methods that a mailet or matcher uses to communicate</em>
+<a name="31" href="#31">31</a> <em> * with its mailet container, for example, to send a new message, to</em>
+<a name="32" href="#32">32</a> <em> * deliver a message locally, or write to a log file.</em>
+<a name="33" href="#33">33</a> <em> *</em>
+<a name="34" href="#34">34</a> <em> * The MailetContext object is contained within the MailetConfig and</em>
+<a name="35" href="#35">35</a> <em> * MatcherConfig objects, which the mailet container provides to the</em>
+<a name="36" href="#36">36</a> <em> * mailets and matchers when they are initialized.</em>
+<a name="37" href="#37">37</a> <em> *</em>
+<a name="38" href="#38">38</a> <em> * @version 1.0.0, 24/04/1999</em>
+<a name="39" href="#39">39</a> <em> */</em>
+<a name="40" href="#40">40</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/apache/mailet/MailetContext.html">MailetContext</a> {
+<a name="41" href="#41">41</a>
+<a name="42" href="#42">42</a> <em>/**<em>*</em></em>
+<a name="43" href="#43">43</a> <em> * Bounces the message using a standard format with the given message.</em>
+<a name="44" href="#44">44</a> <em> * The message will be sent back to the sender from the postmaster as specified for</em>
+<a name="45" href="#45">45</a> <em> * this mailet context, adding message to top of mail server queue using</em>
+<a name="46" href="#46">46</a> <em> * sendMail().</em>
+<a name="47" href="#47">47</a> <em> *</em>
+<a name="48" href="#48">48</a> <em> * @param mail - the message that is to be bounced and sender to whom to return the message</em>
+<a name="49" href="#49">49</a> <em> * @param message - a descriptive message as to why the message bounced</em>
+<a name="50" href="#50">50</a> <em> */</em>
+<a name="51" href="#51">51</a> <strong>void</strong> bounce(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail, String message) throws MessagingException;
+<a name="52" href="#52">52</a>
+<a name="53" href="#53">53</a> <em>/**<em>*</em></em>
+<a name="54" href="#54">54</a> <em> * Bounces the email message using the provided email address as the</em>
+<a name="55" href="#55">55</a> <em> * sender of the bounce.</em>
+<a name="56" href="#56">56</a> <em> *</em>
+<a name="57" href="#57">57</a> <em> * @param mail - the message that is to be bounced and sender to whom to return the message</em>
+<a name="58" href="#58">58</a> <em> * @param message - a descriptive message as to why the message bounced</em>
+<a name="59" href="#59">59</a> <em> * @param bouncer - the address to give as the sender of the bounced message</em>
+<a name="60" href="#60">60</a> <em> */</em>
+<a name="61" href="#61">61</a> <strong>void</strong> bounce(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail, String message, <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> bouncer) throws MessagingException;
+<a name="62" href="#62">62</a>
+<a name="63" href="#63">63</a> <em>/**<em>*</em></em>
+<a name="64" href="#64">64</a> <em> * Returns a Collection of Strings of hostnames or ip addresses that</em>
+<a name="65" href="#65">65</a> <em> * are specified as mail server listeners for the given hostname.</em>
+<a name="66" href="#66">66</a> <em> * This is done using MX records, and the hostnames or ip addresses</em>
+<a name="67" href="#67">67</a> <em> * are returned sorted by MX priority.</em>
+<a name="68" href="#68">68</a> <em> *</em>
+<a name="69" href="#69">69</a> <em> * <p>TODO: This needs to be made a more specific ordered subtype of Collection.</p></em>
+<a name="70" href="#70">70</a> <em> * </em>
+<a name="71" href="#71">71</a> <em> * @param host - the domain name for which to find mail servers</em>
+<a name="72" href="#72">72</a> <em> * @return a Collection of Strings of hostnames, sorted by priority</em>
+<a name="73" href="#73">73</a> <em> */</em>
+<a name="74" href="#74">74</a> Collection getMailServers(String host);
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> <em>/**<em>*</em></em>
+<a name="77" href="#77">77</a> <em> * Returns the postmaster's address for this mailet context.</em>
+<a name="78" href="#78">78</a> <em> *</em>
+<a name="79" href="#79">79</a> <em> * @return a MailAddress of the Postmaster's address</em>
+<a name="80" href="#80">80</a> <em> */</em>
+<a name="81" href="#81">81</a> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> getPostmaster();
+<a name="82" href="#82">82</a>
+<a name="83" href="#83">83</a> <em>/**<em>*</em></em>
+<a name="84" href="#84">84</a> <em> * Returns the mailet container attribute with the given name, or null</em>
+<a name="85" href="#85">85</a> <em> * if there is no attribute by that name. An attribute allows a mailet container</em>
+<a name="86" href="#86">86</a> <em> * to give the mailet additional information not already provided by this interface.</em>
+<a name="87" href="#87">87</a> <em> * See your server documentation for information about its attributes. A list of</em>
+<a name="88" href="#88">88</a> <em> * supported attributes can be retrieved using getAttributeNames.</em>
+<a name="89" href="#89">89</a> <em> * <p></em>
+<a name="90" href="#90">90</a> <em> * The attribute is returned as a java.lang.Object or some subclass. Attribute</em>
+<a name="91" href="#91">91</a> <em> * names should follow the same convention as package names. The Java Mailet API</em>
+<a name="92" href="#92">92</a> <em> * specification reserves names matching java.*, javax.*, and sun.*</em>
+<a name="93" href="#93">93</a> <em> *</em>
+<a name="94" href="#94">94</a> <em> * @param name - a String specifying the name of the attribute</em>
+<a name="95" href="#95">95</a> <em> * @return an Object containing the value of the attribute, or null if no attribute</em>
+<a name="96" href="#96">96</a> <em> * exists matching the given name</em>
+<a name="97" href="#97">97</a> <em> */</em>
+<a name="98" href="#98">98</a> Object getAttribute(String name);
+<a name="99" href="#99">99</a>
+<a name="100" href="#100">100</a> <em>/**<em>*</em></em>
+<a name="101" href="#101">101</a> <em> * Returns an Iterator containing the attribute names available within</em>
+<a name="102" href="#102">102</a> <em> * this mailet context. Use the getAttribute(java.lang.String) method with an</em>
+<a name="103" href="#103">103</a> <em> * attribute name to get the value of an attribute.</em>
+<a name="104" href="#104">104</a> <em> *</em>
+<a name="105" href="#105">105</a> <em> * @return an Iterator of attribute names</em>
+<a name="106" href="#106">106</a> <em> */</em>
+<a name="107" href="#107">107</a> Iterator getAttributeNames();
+<a name="108" href="#108">108</a>
+<a name="109" href="#109">109</a> <em>/**<em>*</em></em>
+<a name="110" href="#110">110</a> <em> * Returns the major version of the Mailet API that this mailet</em>
+<a name="111" href="#111">111</a> <em> * container supports. All implementations that comply with Version 1.2 must have</em>
+<a name="112" href="#112">112</a> <em> * this method return the integer 1.</em>
+<a name="113" href="#113">113</a> <em> *</em>
+<a name="114" href="#114">114</a> <em> * @return 1</em>
+<a name="115" href="#115">115</a> <em> */</em>
+<a name="116" href="#116">116</a> <strong>int</strong> getMajorVersion();
+<a name="117" href="#117">117</a>
+<a name="118" href="#118">118</a> <em>/**<em>*</em></em>
+<a name="119" href="#119">119</a> <em> * Returns the minor version of the Mailet API that this mailet</em>
+<a name="120" href="#120">120</a> <em> * container supports. All implementations that comply with Version 1.2 must have</em>
+<a name="121" href="#121">121</a> <em> * this method return the integer 2.</em>
+<a name="122" href="#122">122</a> <em> *</em>
+<a name="123" href="#123">123</a> <em> * @return 2</em>
+<a name="124" href="#124">124</a> <em> */</em>
+<a name="125" href="#125">125</a> <strong>int</strong> getMinorVersion();
+<a name="126" href="#126">126</a>
+<a name="127" href="#127">127</a> <em>/**<em>*</em></em>
+<a name="128" href="#128">128</a> <em> * Returns the name and version of the mailet container on which</em>
+<a name="129" href="#129">129</a> <em> * the mailet is running.</em>
+<a name="130" href="#130">130</a> <em> * <p></em>
+<a name="131" href="#131">131</a> <em> * The form of the returned string is servername/versionnumber. For example,</em>
+<a name="132" href="#132">132</a> <em> * JAMES may return the string JAMES/1.2.</em>
+<a name="133" href="#133">133</a> <em> * <p></em>
+<a name="134" href="#134">134</a> <em> * The mailet container may return other optional information after the primary</em>
+<a name="135" href="#135">135</a> <em> * string in parentheses, for example, JAMES/1.2 (JDK 1.3.0; Windows NT 4.0 x86).</em>
+<a name="136" href="#136">136</a> <em> *</em>
+<a name="137" href="#137">137</a> <em> * @return a String containing at least the mailet container name and version number</em>
+<a name="138" href="#138">138</a> <em> */</em>
+<a name="139" href="#139">139</a> String getServerInfo();
+<a name="140" href="#140">140</a>
+<a name="141" href="#141">141</a> <em>/**<em>*</em></em>
+<a name="142" href="#142">142</a> <em> * Checks if a server is serviced by mail context</em>
+<a name="143" href="#143">143</a> <em> *</em>
+<a name="144" href="#144">144</a> <em> * @param serverName - name of server.</em>
+<a name="145" href="#145">145</a> <em> * @return true if server is local, i.e. serviced by this mail context</em>
+<a name="146" href="#146">146</a> <em> */</em>
+<a name="147" href="#147">147</a> <strong>boolean</strong> isLocalServer(String serverName);
+<a name="148" href="#148">148</a>
+<a name="149" href="#149">149</a> <em>/**<em>*</em></em>
+<a name="150" href="#150">150</a> <em> * Checks if a user account is exists in the mail context.</em>
+<a name="151" href="#151">151</a> <em> *</em>
+<a name="152" href="#152">152</a> <em> * @param userAccount - user identifier.</em>
+<a name="153" href="#153">153</a> <em> * @return true if the account is a local account</em>
+<a name="154" href="#154">154</a> <em> * </em>
+<a name="155" href="#155">155</a> <em> * @deprecated use isLocalEmail(MailAddress) instead</em>
+<a name="156" href="#156">156</a> <em> * </em>
+<a name="157" href="#157">157</a> <em> * @since James 2.4.0 this method expect to receive also the domain</em>
+<a name="158" href="#158">158</a> <em> * name within the userAccount string (user\@domain).</em>
+<a name="159" href="#159">159</a> <em> * By default it will use \@localhost when no domain is passed.</em>
+<a name="160" href="#160">160</a> <em> */</em>
+<a name="161" href="#161">161</a> <strong>boolean</strong> isLocalUser(String userAccount);
+<a name="162" href="#162">162</a>
+<a name="163" href="#163">163</a> <em>/**<em>*</em></em>
+<a name="164" href="#164">164</a> <em> * Checks if a user account is exists in the mail context.</em>
+<a name="165" href="#165">165</a> <em> *</em>
+<a name="166" href="#166">166</a> <em> * @param mailAddress - address of the account to be checked.</em>
+<a name="167" href="#167">167</a> <em> * @return true if the account is a local account</em>
+<a name="168" href="#168">168</a> <em> * </em>
+<a name="169" href="#169">169</a> <em> * @since James 2.4.0</em>
+<a name="170" href="#170">170</a> <em> */</em>
+<a name="171" href="#171">171</a> <strong>boolean</strong> isLocalEmail(<a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> mailAddress);
+<a name="172" href="#172">172</a>
+<a name="173" href="#173">173</a> <em>/**<em>*</em></em>
+<a name="174" href="#174">174</a> <em> * Writes the specified message to a mailet log file, usually an event</em>
+<a name="175" href="#175">175</a> <em> * log. The name and type of the mailet log file is specific to the mailet</em>
+<a name="176" href="#176">176</a> <em> * container.</em>
+<a name="177" href="#177">177</a> <em> *</em>
+<a name="178" href="#178">178</a> <em> * @param message - a String specifying the message to be written to the log file</em>
+<a name="179" href="#179">179</a> <em> */</em>
+<a name="180" href="#180">180</a> <strong>void</strong> log(String message);
+<a name="181" href="#181">181</a>
+<a name="182" href="#182">182</a> <em>/**<em>*</em></em>
+<a name="183" href="#183">183</a> <em> * Writes an explanatory message and a stack trace for a given Throwable</em>
+<a name="184" href="#184">184</a> <em> * exception to the mailet log file.</em>
+<a name="185" href="#185">185</a> <em> *</em>
+<a name="186" href="#186">186</a> <em> * @param message - a String that describes the error or exception</em>
+<a name="187" href="#187">187</a> <em> * @param t - the Throwable error or exception</em>
+<a name="188" href="#188">188</a> <em> */</em>
+<a name="189" href="#189">189</a> <strong>void</strong> log(String message, Throwable t);
+<a name="190" href="#190">190</a>
+<a name="191" href="#191">191</a> <em>/**<em>*</em></em>
+<a name="192" href="#192">192</a> <em> * Removes the attribute with the given name from the mailet context. After</em>
+<a name="193" href="#193">193</a> <em> * removal, subsequent calls to getAttribute(java.lang.String) to retrieve</em>
+<a name="194" href="#194">194</a> <em> * the attribute's value will return null.</em>
+<a name="195" href="#195">195</a> <em> *</em>
+<a name="196" href="#196">196</a> <em> * @param name - a String specifying the name of the attribute to be removed</em>
+<a name="197" href="#197">197</a> <em> */</em>
+<a name="198" href="#198">198</a> <strong>void</strong> removeAttribute(String name);
+<a name="199" href="#199">199</a>
+<a name="200" href="#200">200</a> <em>/**<em>*</em></em>
+<a name="201" href="#201">201</a> <em> * Send an outgoing message to the top of this mailet container's root queue.</em>
+<a name="202" href="#202">202</a> <em> * This is the equivalent of opening an SMTP session to localhost.</em>
+<a name="203" href="#203">203</a> <em> * This uses sender and recipients as specified in the message itself.</em>
+<a name="204" href="#204">204</a> <em> *</em>
+<a name="205" href="#205">205</a> <em> * @param msg - the MimeMessage of the headers and body content of the outgoing message</em>
+<a name="206" href="#206">206</a> <em> * @throws MessagingException - if the message fails to parse</em>
+<a name="207" href="#207">207</a> <em> */</em>
+<a name="208" href="#208">208</a> <strong>void</strong> sendMail(MimeMessage msg)
+<a name="209" href="#209">209</a> throws MessagingException;
+<a name="210" href="#210">210</a>
+<a name="211" href="#211">211</a> <em>/**<em>*</em></em>
+<a name="212" href="#212">212</a> <em> * Send an outgoing message to the top of this mailet container's root queue.</em>
+<a name="213" href="#213">213</a> <em> * This is the equivalent of opening an SMTP session to localhost.</em>
+<a name="214" href="#214">214</a> <em> *</em>
+<a name="215" href="#215">215</a> <em> * @param sender - the sender of the message</em>
+<a name="216" href="#216">216</a> <em> * @param recipients - a Collection of MailAddress objects of recipients</em>
+<a name="217" href="#217">217</a> <em> * @param msg - the MimeMessage of the headers and body content of the outgoing message</em>
+<a name="218" href="#218">218</a> <em> * @throws MessagingException - if the message fails to parse</em>
+<a name="219" href="#219">219</a> <em> */</em>
+<a name="220" href="#220">220</a> <strong>void</strong> sendMail(<a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> sender, Collection recipients, MimeMessage msg)
+<a name="221" href="#221">221</a> throws MessagingException;
+<a name="222" href="#222">222</a>
+<a name="223" href="#223">223</a> <em>/**<em>*</em></em>
+<a name="224" href="#224">224</a> <em> * Send an outgoing message to the top of this mailet container queue for the</em>
+<a name="225" href="#225">225</a> <em> * appropriate processor that is specified.</em>
+<a name="226" href="#226">226</a> <em> *</em>
+<a name="227" href="#227">227</a> <em> * @param sender - the sender of the message</em>
+<a name="228" href="#228">228</a> <em> * @param recipients - a Collection of MailAddress objects of recipients</em>
+<a name="229" href="#229">229</a> <em> * @param msg - the MimeMessage of the headers and body content of the outgoing message</em>
+<a name="230" href="#230">230</a> <em> * @param state - the state of the message, indicates which processor to use</em>
+<a name="231" href="#231">231</a> <em> * This is a String that names a processor for which the message will be queued</em>
+<a name="232" href="#232">232</a> <em> * @throws MessagingException - if the message fails to parse</em>
+<a name="233" href="#233">233</a> <em> */</em>
+<a name="234" href="#234">234</a> <strong>void</strong> sendMail(<a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> sender, Collection recipients, MimeMessage msg, String state)
+<a name="235" href="#235">235</a> throws MessagingException;
+<a name="236" href="#236">236</a>
+<a name="237" href="#237">237</a> <em>/**<em>*</em></em>
+<a name="238" href="#238">238</a> <em> * Send an outgoing message to the top of this mailet container's root queue.</em>
+<a name="239" href="#239">239</a> <em> * This is the equivalent of opening an SMTP session to localhost.</em>
+<a name="240" href="#240">240</a> <em> * The Mail object provides all envelope and content information</em>
+<a name="241" href="#241">241</a> <em> *</em>
+<a name="242" href="#242">242</a> <em> * @param mail - the message that is to sent</em>
+<a name="243" href="#243">243</a> <em> * @throws MessagingException - if the message fails to spool</em>
+<a name="244" href="#244">244</a> <em> */</em>
+<a name="245" href="#245">245</a> <strong>void</strong> sendMail(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail)
+<a name="246" href="#246">246</a> throws MessagingException;
+<a name="247" href="#247">247</a>
+<a name="248" href="#248">248</a> <em>/**<em>*</em></em>
+<a name="249" href="#249">249</a> <em> * Binds an object to a given attribute name in this mailet context. If the name</em>
+<a name="250" href="#250">250</a> <em> * specified is already used for an attribute, this method will remove the old</em>
+<a name="251" href="#251">251</a> <em> * attribute and bind the name to the new attribute.</em>
+<a name="252" href="#252">252</a> <em> * <p></em>
+<a name="253" href="#253">253</a> <em> * Attribute names should follow the same convention as package names. The Java</em>
+<a name="254" href="#254">254</a> <em> * Mailet API specification reserves names matching java.*, javax.*, and sun.*.</em>
+<a name="255" href="#255">255</a> <em> *</em>
+<a name="256" href="#256">256</a> <em> * @param name - a String specifying the name of the attribute</em>
+<a name="257" href="#257">257</a> <em> * @param object - an Object representing the attribute to be bound</em>
+<a name="258" href="#258">258</a> <em> */</em>
+<a name="259" href="#259">259</a> <strong>void</strong> setAttribute(String name, Object object);
+<a name="260" href="#260">260</a>
+<a name="261" href="#261">261</a> <em>/**<em>*</em></em>
+<a name="262" href="#262">262</a> <em> * Stores the message is in the local repository associated with</em>
+<a name="263" href="#263">263</a> <em> * recipient for later retrieval, e.g., by a POP3 or IMAP service.</em>
+<a name="264" href="#264">264</a> <em> *</em>
+<a name="265" href="#265">265</a> <em> * @deprecated - use sparingly. Service will be replaced with</em>
+<a name="266" href="#266">266</a> <em> * resource acquired via JNDI.</em>
+<a name="267" href="#267">267</a> <em> * @param sender - the sender of the incoming message</em>
+<a name="268" href="#268">268</a> <em> * @param recipient - the user who is receiving this message (as a complete email address)</em>
+<a name="269" href="#269">269</a> <em> * @param msg - the MimeMessage to store in a local mailbox</em>
+<a name="270" href="#270">270</a> <em> * @throws MessagingException - if the message fails to parse</em>
+<a name="271" href="#271">271</a> <em> */</em>
+<a name="272" href="#272">272</a> <strong>void</strong> storeMail(<a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> sender, <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> recipient, MimeMessage msg)
+<a name="273" href="#273">273</a> throws MessagingException;
+<a name="274" href="#274">274</a>
+<a name="275" href="#275">275</a> <em>/**<em>*</em></em>
+<a name="276" href="#276">276</a> <em> * Returns an Iterator over HostAddress, a specialized subclass of</em>
+<a name="277" href="#277">277</a> <em> * javax.mail.URLName, which provides location information for</em>
+<a name="278" href="#278">278</a> <em> * servers that are specified as mail handlers for the given</em>
+<a name="279" href="#279">279</a> <em> * hostname. This is done using MX records, and the HostAddress</em>
+<a name="280" href="#280">280</a> <em> * instances are returned sorted by MX priority. If no host is</em>
+<a name="281" href="#281">281</a> <em> * found for domainName, the Iterator returned will be empty and the</em>
+<a name="282" href="#282">282</a> <em> * first call to hasNext() will return false.</em>
+<a name="283" href="#283">283</a> <em> *</em>
+<a name="284" href="#284">284</a> <em> * @since Mailet API v2.2.0a16-unstable</em>
+<a name="285" href="#285">285</a> <em> * @param domainName - the domain for which to find mail servers</em>
+<a name="286" href="#286">286</a> <em> * @return an Iterator over HostAddress instances, sorted by priority</em>
+<a name="287" href="#287">287</a> <em> */</em>
+<a name="288" href="#288">288</a> Iterator getSMTPHostAddresses(String domainName);
+<a name="289" href="#289">289</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/xref/org/apache/mailet/MailetException.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/xref/org/apache/mailet/MailetException.html?view=auto&rev=536230
==============================================================================
--- james/site/trunk/www/mailet/xref/org/apache/mailet/MailetException.html (added)
+++ james/site/trunk/www/mailet/xref/org/apache/mailet/MailetException.html Tue May 8 08:59:25 2007
@@ -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>MailetException xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../apidocs/org/apache/mailet/MailetException.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em>/**<em>***************************************************************</em></em>
+<a name="2" href="#2">2</a> <em> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em> * *</em>
+<a name="10" href="#10">10</a> <em> * <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> * *</em>
+<a name="12" href="#12">12</a> <em> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em> * under the License. *</em>
+<a name="18" href="#18">18</a> <em> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong>package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong>import</strong> javax.mail.MessagingException;
+<a name="24" href="#24">24</a>
+<a name="25" href="#25">25</a> <em>/**<em>*</em></em>
+<a name="26" href="#26">26</a> <em> * Defines a general exception a mailet can throw when it encounters difficulty.</em>
+<a name="27" href="#27">27</a> <em> *</em>
+<a name="28" href="#28">28</a> <em> * @version 1.0.0, 24/04/1999</em>
+<a name="29" href="#29">29</a> <em> */</em>
+<a name="30" href="#30">30</a> <strong>public</strong> <strong>class</strong> <a href="../../../org/apache/mailet/MailetException.html">MailetException</a> <strong>extends</strong> MessagingException {
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em>/**<em>*</em></em>
+<a name="33" href="#33">33</a> <em> * Constructs a new mailet exception.</em>
+<a name="34" href="#34">34</a> <em> */</em>
+<a name="35" href="#35">35</a> <strong>public</strong> <a href="../../../org/apache/mailet/MailetException.html">MailetException</a>() {
+<a name="36" href="#36">36</a> <strong>super</strong>();
+<a name="37" href="#37">37</a> }
+<a name="38" href="#38">38</a>
+<a name="39" href="#39">39</a> <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a> <em> * Constructs a new mailet exception with the specified message.</em>
+<a name="41" href="#41">41</a> <em> */</em>
+<a name="42" href="#42">42</a> <strong>public</strong> <a href="../../../org/apache/mailet/MailetException.html">MailetException</a>(String message) {
+<a name="43" href="#43">43</a> <strong>super</strong>(message);
+<a name="44" href="#44">44</a> }
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em>/**<em>*</em></em>
+<a name="47" href="#47">47</a> <em> * Constructs a new mailet exception when the mailet needs to throw</em>
+<a name="48" href="#48">48</a> <em> * an exception and include a message about the "root cause" exception</em>
+<a name="49" href="#49">49</a> <em> * that interfered with its normal operation, including a description</em>
+<a name="50" href="#50">50</a> <em> * message.</em>
+<a name="51" href="#51">51</a> <em> */</em>
+<a name="52" href="#52">52</a> <strong>public</strong> <a href="../../../org/apache/mailet/MailetException.html">MailetException</a>(String message, Exception e) {
+<a name="53" href="#53">53</a> <strong>super</strong>(message, e);
+<a name="54" href="#54">54</a> }
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</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/xref/org/apache/mailet/Matcher.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/xref/org/apache/mailet/Matcher.html?view=auto&rev=536230
==============================================================================
--- james/site/trunk/www/mailet/xref/org/apache/mailet/Matcher.html (added)
+++ james/site/trunk/www/mailet/xref/org/apache/mailet/Matcher.html Tue May 8 08:59:25 2007
@@ -0,0 +1,153 @@
+<!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>Matcher xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../apidocs/org/apache/mailet/Matcher.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em>/**<em>***************************************************************</em></em>
+<a name="2" href="#2">2</a> <em> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em> * *</em>
+<a name="10" href="#10">10</a> <em> * <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> * *</em>
+<a name="12" href="#12">12</a> <em> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em> * under the License. *</em>
+<a name="18" href="#18">18</a> <em> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong>package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong>import</strong> java.util.Collection;
+<a name="24" href="#24">24</a>
+<a name="25" href="#25">25</a> <em>/**<em>*</em></em>
+<a name="26" href="#26">26</a> <em> * This interface define the behaviour of the message "routing" inside</em>
+<a name="27" href="#27">27</a> <em> * the mailet container. The match(Mail) method returns a Collection of</em>
+<a name="28" href="#28">28</a> <em> * recipients that meet this class's criteria.</em>
+<a name="29" href="#29">29</a> <em> * <p></em>
+<a name="30" href="#30">30</a> <em> * An important feature of the mailet container is the ability to fork</em>
+<a name="31" href="#31">31</a> <em> * processing of messages. When a message first arrives at the server,</em>
+<a name="32" href="#32">32</a> <em> * it might have multiple recipients specified. As a message is passed</em>
+<a name="33" href="#33">33</a> <em> * to a matcher, the matcher might only "match" one of the listed</em>
+<a name="34" href="#34">34</a> <em> * recipients. It would then return only the matching recipient in</em>
+<a name="35" href="#35">35</a> <em> * the Collection. The mailet container should then duplicate the</em>
+<a name="36" href="#36">36</a> <em> * message splitting the recipient list across the two messages as per</em>
+<a name="37" href="#37">37</a> <em> * what the matcher returned.</em>
+<a name="38" href="#38">38</a> <em> * <p></em>
+<a name="39" href="#39">39</a> <em> * <b>[THIS PARAGRAPH NOT YET IMPLEMENTED]</b></em>
+<a name="40" href="#40">40</a> <em> * <i>The matcher can extend this forking to further separation by returning</em>
+<a name="41" href="#41">41</a> <em> * a Collection of Collection objects. This allows a matcher to fork</em>
+<a name="42" href="#42">42</a> <em> * multiple processes if there are multiple recipients that require</em>
+<a name="43" href="#43">43</a> <em> * separate processing. For example, we could write a ListservMatcher</em>
+<a name="44" href="#44">44</a> <em> * that handles multiple listservs. When someone cross-posts across</em>
+<a name="45" href="#45">45</a> <em> * multiple listservs that this matcher handles, it could put each</em>
+<a name="46" href="#46">46</a> <em> * listserv address (recipient) that it handles in a separate Collection</em>
+<a name="47" href="#47">47</a> <em> * object. By returning each of these Collections within a container</em>
+<a name="48" href="#48">48</a> <em> * Collection object, it could indicate to the mailet container how</em>
+<a name="49" href="#49">49</a> <em> * many forks to spawn.</i></em>
+<a name="50" href="#50">50</a> <em> * <p></em>
+<a name="51" href="#51">51</a> <em> * This interface defines methods to initialize a matcher, to match</em>
+<a name="52" href="#52">52</a> <em> * messages, and to remove a matcher from the server. These are known</em>
+<a name="53" href="#53">53</a> <em> * as life-cycle methods and are called in the following sequence:</em>
+<a name="54" href="#54">54</a> <em> * <ol></em>
+<a name="55" href="#55">55</a> <em> * <li>The matcher is constructed, then initialized with the init method.</li></em>
+<a name="56" href="#56">56</a> <em> * <li>Any calls from clients to the match method are handled.</li></em>
+<a name="57" href="#57">57</a> <em> * <li>The matcher is taken out of service, then destroyed with the</em>
+<a name="58" href="#58">58</a> <em> * destroy method, then garbage collected and finalized.</li></em>
+<a name="59" href="#59">59</a> <em> * </ol></em>
+<a name="60" href="#60">60</a> <em> * In addition to the life-cycle methods, this interface provides the</em>
+<a name="61" href="#61">61</a> <em> * getMatcherConfig method, which the matcher can use to get any startup</em>
+<a name="62" href="#62">62</a> <em> * information, and the getMatcherInfo method, which allows the matcher</em>
+<a name="63" href="#63">63</a> <em> * to return basic information about itself, such as author, version,</em>
+<a name="64" href="#64">64</a> <em> * and copyright.</em>
+<a name="65" href="#65">65</a> <em> *</em>
+<a name="66" href="#66">66</a> <em> * @version 1.0.0, 24/04/1999</em>
+<a name="67" href="#67">67</a> <em> */</em>
+<a name="68" href="#68">68</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/apache/mailet/Matcher.html">Matcher</a> {
+<a name="69" href="#69">69</a>
+<a name="70" href="#70">70</a> <em>/**<em>*</em></em>
+<a name="71" href="#71">71</a> <em> * Called by the mailet container to indicate to a matcher that the matcher</em>
+<a name="72" href="#72">72</a> <em> * is being taken out of service. This method is only called once all threads</em>
+<a name="73" href="#73">73</a> <em> * within the matcher's service method have exited or after a timeout period</em>
+<a name="74" href="#74">74</a> <em> * has passed. After the mailet container calls this method, it will not call</em>
+<a name="75" href="#75">75</a> <em> * the match method again on this matcher.</em>
+<a name="76" href="#76">76</a> <em> * <p></em>
+<a name="77" href="#77">77</a> <em> * This method gives the matcher an opportunity to clean up any resources that</em>
+<a name="78" href="#78">78</a> <em> * are being held (for example, memory, file handles, threads) and make sure</em>
+<a name="79" href="#79">79</a> <em> * that any persistent state is synchronized with the matcher's current state in memory.</em>
+<a name="80" href="#80">80</a> <em> */</em>
+<a name="81" href="#81">81</a> <strong>void</strong> destroy();
+<a name="82" href="#82">82</a>
+<a name="83" href="#83">83</a> <em>/**<em>*</em></em>
+<a name="84" href="#84">84</a> <em> * Returns a MatcherConfig object, which contains initialization and</em>
+<a name="85" href="#85">85</a> <em> * startup parameters for this matcher.</em>
+<a name="86" href="#86">86</a> <em> * <p></em>
+<a name="87" href="#87">87</a> <em> * Implementations of this interface are responsible for storing the</em>
+<a name="88" href="#88">88</a> <em> * MatcherConfig object so that this method can return it. The GenericMatcher</em>
+<a name="89" href="#89">89</a> <em> * class, which implements this interface, already does this.</em>
+<a name="90" href="#90">90</a> <em> *</em>
+<a name="91" href="#91">91</a> <em> * @return the MatcherConfig object that initializes this matcher</em>
+<a name="92" href="#92">92</a> <em> */</em>
+<a name="93" href="#93">93</a> <a href="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</a> getMatcherConfig();
+<a name="94" href="#94">94</a>
+<a name="95" href="#95">95</a> <em>/**<em>*</em></em>
+<a name="96" href="#96">96</a> <em> * Returns information about the matcher, such as author, version, and copyright.</em>
+<a name="97" href="#97">97</a> <em> * <p></em>
+<a name="98" href="#98">98</a> <em> * The string that this method returns should be plain text and not markup</em>
+<a name="99" href="#99">99</a> <em> * of any kind (such as HTML, XML, etc.).</em>
+<a name="100" href="#100">100</a> <em> *</em>
+<a name="101" href="#101">101</a> <em> * @return a String containing matcher information</em>
+<a name="102" href="#102">102</a> <em> */</em>
+<a name="103" href="#103">103</a> String getMatcherInfo();
+<a name="104" href="#104">104</a>
+<a name="105" href="#105">105</a> <em>/**<em>*</em></em>
+<a name="106" href="#106">106</a> <em> * Called by the mailet container to indicate to a matcher that the</em>
+<a name="107" href="#107">107</a> <em> * matcher is being placed into service.</em>
+<a name="108" href="#108">108</a> <em> * <p></em>
+<a name="109" href="#109">109</a> <em> * The mailet container calls the init method exactly once after instantiating</em>
+<a name="110" href="#110">110</a> <em> * the matcher. The init method must complete successfully before the matcher</em>
+<a name="111" href="#111">111</a> <em> * can receive any messages.</em>
+<a name="112" href="#112">112</a> <em> *</em>
+<a name="113" href="#113">113</a> <em> * @param config - a MatcherConfig object containing the matcher's configuration</em>
+<a name="114" href="#114">114</a> <em> * and initialization parameters</em>
+<a name="115" href="#115">115</a> <em> * @throws javax.mail.MessagingException - if an exception has occurred that</em>
+<a name="116" href="#116">116</a> <em> * interferes with the matcher's normal operation</em>
+<a name="117" href="#117">117</a> <em> */</em>
+<a name="118" href="#118">118</a> <strong>void</strong> init( MatcherConfig config ) throws javax.mail.MessagingException;
+<a name="119" href="#119">119</a>
+<a name="120" href="#120">120</a> <em>/**<em>*</em></em>
+<a name="121" href="#121">121</a> <em> * Takes a Mail message, looks at any pertinent information, and then returns a subset</em>
+<a name="122" href="#122">122</a> <em> * of recipients that meet the "match" conditions.</em>
+<a name="123" href="#123">123</a> <em> * <p></em>
+<a name="124" href="#124">124</a> <em> * This method is only called after the matcher's init() method has completed</em>
+<a name="125" href="#125">125</a> <em> * successfully.</em>
+<a name="126" href="#126">126</a> <em> * <p></em>
+<a name="127" href="#127">127</a> <em> * Matchers typically run inside multithreaded mailet containers that can handle</em>
+<a name="128" href="#128">128</a> <em> * multiple requests concurrently. Developers must be aware to synchronize access</em>
+<a name="129" href="#129">129</a> <em> * to any shared resources such as files, network connections, and as well as the</em>
+<a name="130" href="#130">130</a> <em> * matcher's class and instance variables. More information on multithreaded</em>
+<a name="131" href="#131">131</a> <em> * programming in Java is available in <a href="<a href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html" target="alexandria_uri">http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html</a>">the</em>
+<a name="132" href="#132">132</a> <em> * Java tutorial on multi-threaded programming</a>.</em>
+<a name="133" href="#133">133</a> <em> *</em>
+<a name="134" href="#134">134</a> <em> * @param mail - the Mail object that contains the message and routing information</em>
+<a name="135" href="#135">135</a> <em> * @return a Collection of String objects (recipients) that meet the match criteria</em>
+<a name="136" href="#136">136</a> <em> * @throws javax.mail.MessagingException - if an message or address parsing exception occurs or</em>
+<a name="137" href="#137">137</a> <em> * an exception that interferes with the matcher's normal operation</em>
+<a name="138" href="#138">138</a> <em> */</em>
+<a name="139" href="#139">139</a> Collection match( Mail mail ) throws javax.mail.MessagingException;
+<a name="140" href="#140">140</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/xref/org/apache/mailet/MatcherConfig.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/xref/org/apache/mailet/MatcherConfig.html?view=auto&rev=536230
==============================================================================
--- james/site/trunk/www/mailet/xref/org/apache/mailet/MatcherConfig.html (added)
+++ james/site/trunk/www/mailet/xref/org/apache/mailet/MatcherConfig.html Tue May 8 08:59:25 2007
@@ -0,0 +1,73 @@
+<!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>MatcherConfig xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../apidocs/org/apache/mailet/MatcherConfig.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em>/**<em>***************************************************************</em></em>
+<a name="2" href="#2">2</a> <em> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em> * *</em>
+<a name="10" href="#10">10</a> <em> * <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> * *</em>
+<a name="12" href="#12">12</a> <em> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em> * under the License. *</em>
+<a name="18" href="#18">18</a> <em> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong>package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <em>/**<em>*</em></em>
+<a name="24" href="#24">24</a> <em> * A matcher configuration object used by a mailet container used to pass information</em>
+<a name="25" href="#25">25</a> <em> * to a matcher during initialization.</em>
+<a name="26" href="#26">26</a> <em> * <p></em>
+<a name="27" href="#27">27</a> <em> * The configuration information contains an initialization parameter,</em>
+<a name="28" href="#28">28</a> <em> * which is set as a condition String, and a MailetContext object,</em>
+<a name="29" href="#29">29</a> <em> * which gives the mailet information about the mailet container.</em>
+<a name="30" href="#30">30</a> <em> *</em>
+<a name="31" href="#31">31</a> <em> * @version 1.0.0, 24/04/1999</em>
+<a name="32" href="#32">32</a> <em> */</em>
+<a name="33" href="#33">33</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</a> {
+<a name="34" href="#34">34</a>
+<a name="35" href="#35">35</a> <em>/**<em>*</em></em>
+<a name="36" href="#36">36</a> <em> * The simple condition defined for this matcher, e.g., for</em>
+<a name="37" href="#37">37</a> <em> * SenderIs=admin@localhost, this would return admin@localhost.</em>
+<a name="38" href="#38">38</a> <em> *</em>
+<a name="39" href="#39">39</a> <em> * @return a String containing the value of the initialization parameter</em>
+<a name="40" href="#40">40</a> <em> */</em>
+<a name="41" href="#41">41</a> String getCondition();
+<a name="42" href="#42">42</a>
+<a name="43" href="#43">43</a> <em>/**<em>*</em></em>
+<a name="44" href="#44">44</a> <em> * Returns a reference to the MailetContext in which the matcher is executing</em>
+<a name="45" href="#45">45</a> <em> *</em>
+<a name="46" href="#46">46</a> <em> * @return a MailetContext object, used by the matcher to interact with its</em>
+<a name="47" href="#47">47</a> <em> * mailet container</em>
+<a name="48" href="#48">48</a> <em> */</em>
+<a name="49" href="#49">49</a> <a href="../../../org/apache/mailet/MailetContext.html">MailetContext</a> getMailetContext();
+<a name="50" href="#50">50</a>
+<a name="51" href="#51">51</a> <em>/**<em>*</em></em>
+<a name="52" href="#52">52</a> <em> * Returns the name of this matcher instance. The name may be provided via server</em>
+<a name="53" href="#53">53</a> <em> * administration, assigned in the application deployment descriptor, or for</em>
+<a name="54" href="#54">54</a> <em> * an unregistered (and thus unnamed) matcher instance it will be the matcher's</em>
+<a name="55" href="#55">55</a> <em> * class name.</em>
+<a name="56" href="#56">56</a> <em> *</em>
+<a name="57" href="#57">57</a> <em> * @return the name of the matcher instance</em>
+<a name="58" href="#58">58</a> <em> */</em>
+<a name="59" href="#59">59</a> String getMatcherName();
+<a name="60" href="#60">60</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+