Added: james/site/trunk/www/mailet/api/xref/index.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/index.html?rev=687845&view=auto ============================================================================== --- james/site/trunk/www/mailet/api/xref/index.html (added) +++ james/site/trunk/www/mailet/api/xref/index.html Thu Aug 21 13:15:10 2008 @@ -0,0 +1,24 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "DTD/xhtml1-frameset.dtd"> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>Apache Mailet API 2.4-SNAPSHOT Reference</title> + </head> + <frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="overview-frame.html" name="packageListFrame" /> + <frame src="allclasses-frame.html" name="packageFrame" /> + </frameset> + <frame src="overview-summary.html" name="classFrame" /> + <noframes> + <body> + <h1>Frame Alert</h1> + <p> + You don't have frames. Go <a href="overview-summary.html">here</a> + </p> + </body> + </noframes> + </frameset> +</html> +
Added: james/site/trunk/www/mailet/api/xref/org/apache/mailet/HostAddress.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/HostAddress.html?rev=687845&view=auto ============================================================================== --- james/site/trunk/www/mailet/api/xref/org/apache/mailet/HostAddress.html (added) +++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/HostAddress.html Thu Aug 21 13:15:10 2008 @@ -0,0 +1,80 @@ +<!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>HostAddress xref</title> +<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../apidocs/org/apache/mailet/HostAddress.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> <strong class="jxr_keyword">package</strong> org.apache.mailet; +<a name="22" href="#22">22</a> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * A specialized subclass of javax.mail.URLName, which provides location</em> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * information for servers.</em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * </em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.2.0a16-unstable</em> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em> +<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/mailet/HostAddress.html">HostAddress</a> <strong class="jxr_keyword">extends</strong> javax.mail.URLName +<a name="30" href="#30">30</a> { +<a name="31" href="#31">31</a> <strong class="jxr_keyword">private</strong> String hostname; +<a name="32" href="#32">32</a> +<a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/mailet/HostAddress.html">HostAddress</a>(String hostname, String url) +<a name="34" href="#34">34</a> { +<a name="35" href="#35">35</a> <strong class="jxr_keyword">super</strong>(url); +<a name="36" href="#36">36</a> <strong class="jxr_keyword">this</strong>.hostname = hostname; +<a name="37" href="#37">37</a> } +<a name="38" href="#38">38</a> +<a name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> String getHostName() +<a name="40" href="#40">40</a> { +<a name="41" href="#41">41</a> <strong class="jxr_keyword">return</strong> hostname; +<a name="42" href="#42">42</a> } +<a name="43" href="#43">43</a> +<a name="44" href="#44">44</a> <em class="jxr_comment">/*</em> +<a name="45" href="#45">45</a> <em class="jxr_comment"> public static void main(String[] args) throws Exception</em> +<a name="46" href="#46">46</a> <em class="jxr_comment"> {</em> +<a name="47" href="#47">47</a> <em class="jxr_comment"> HostAddress url;</em> +<a name="48" href="#48">48</a> <em class="jxr_comment"> try</em> +<a name="49" href="#49">49</a> <em class="jxr_comment"> {</em> +<a name="50" href="#50">50</a> <em class="jxr_comment"> url = new HostAddress("mail.devtech.com", "smtp://" + "66.112.202.2" + ":25");</em> +<a name="51" href="#51">51</a> <em class="jxr_comment"> System.out.println("Hostname: " + url.getHostName());</em> +<a name="52" href="#52">52</a> <em class="jxr_comment"> System.out.println("The protocol is: " + url.getProtocol());</em> +<a name="53" href="#53">53</a> <em class="jxr_comment"> System.out.println("The host is: " + url.getHost());</em> +<a name="54" href="#54">54</a> <em class="jxr_comment"> System.out.println("The port is: " + url.getPort());</em> +<a name="55" href="#55">55</a> <em class="jxr_comment"> System.out.println("The user is: " + url.getUsername());</em> +<a name="56" href="#56">56</a> <em class="jxr_comment"> System.out.println("The password is: " + url.getPassword());</em> +<a name="57" href="#57">57</a> <em class="jxr_comment"> System.out.println("The file is: " + url.getFile());</em> +<a name="58" href="#58">58</a> <em class="jxr_comment"> System.out.println("The ref is: " + url.getRef());</em> +<a name="59" href="#59">59</a> <em class="jxr_comment"> }</em> +<a name="60" href="#60">60</a> <em class="jxr_comment"> catch (Exception e)</em> +<a name="61" href="#61">61</a> <em class="jxr_comment"> {</em> +<a name="62" href="#62">62</a> <em class="jxr_comment"> System.err.println(e);</em> +<a name="63" href="#63">63</a> <em class="jxr_comment"> };</em> +<a name="64" href="#64">64</a> <em class="jxr_comment"> }</em> +<a name="65" href="#65">65</a> <em class="jxr_comment">*/</em> +<a name="66" href="#66">66</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/api/xref/org/apache/mailet/Mail.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mail.html?rev=687845&view=auto ============================================================================== --- james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mail.html (added) +++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mail.html Thu Aug 21 13:15:10 2008 @@ -0,0 +1,220 @@ +<!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>Mail xref</title> +<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../apidocs/org/apache/mailet/Mail.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> <strong class="jxr_keyword">package</strong> org.apache.mailet; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Date; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="28" href="#28">28</a> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Wrap a MimeMessage with routing information (from SMTP) such</em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * as SMTP specified recipients, sender, and ip address and hostname</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * of sending server. It also contains its state which represents</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * which processor in the mailet container it is currently running.</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Special processor names are "root" and "error".</em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @version CVS $Revision: 534853 $ $Date: 2007-05-03 14:39:16 +0100 (Thu, 03 May 2007) $</em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> +<a name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/Mail.html">Mail</a> <strong class="jxr_keyword">extends</strong> Serializable, Cloneable { +<a name="39" href="#39">39</a> String GHOST = <span class="jxr_string">"ghost"</span>; +<a name="40" href="#40">40</a> String DEFAULT = <span class="jxr_string">"root"</span>; +<a name="41" href="#41">41</a> String ERROR = <span class="jxr_string">"error"</span>; +<a name="42" href="#42">42</a> String TRANSPORT = <span class="jxr_string">"transport"</span>; +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Returns the message name of this message</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * </em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @return the message name</em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.3</em> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em> +<a name="49" href="#49">49</a> String getName(); +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Set the message name of this message</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * </em> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @param newName new name</em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.3</em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> +<a name="56" href="#56">56</a> <strong class="jxr_keyword">void</strong> setName(String newName); +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Returns the MimeMessage stored in this message</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 MimeMessage that this Mail object wraps</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @throws MessagingException - an error occured while loading this object</em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em> +<a name="63" href="#63">63</a> MimeMessage getMessage() <strong class="jxr_keyword">throws</strong> MessagingException; +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Returns a Collection of MailAddress objects that are recipients of this message</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @return a Collection of MailAddress objects that are recipients of this message</em> +<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> +<a name="69" href="#69">69</a> Collection getRecipients(); +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Method setRecipients.</em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param recipients a Collection of MailAddress Objects representing the recipients of this message</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @since Mailet API v3.0-unstable</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em> +<a name="75" href="#75">75</a> <strong class="jxr_keyword">void</strong> setRecipients(Collection recipients); +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * The sender of the message, as specified by the MAIL FROM header, or internally defined</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> *</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @return a MailAddress of the sender of this message</em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> +<a name="81" href="#81">81</a> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> getSender(); +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * The current state of the message, such as GHOST, ERROR, or DEFAULT</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> *</em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return the state of this message</em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> +<a name="87" href="#87">87</a> String getState(); +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * The remote hostname of the server that connected to send this message</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @return a String of the hostname of the server that connected to send this message</em> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> */</em> +<a name="93" href="#93">93</a> String getRemoteHost(); +<a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * The remote ip address of the server that connected to send this message</em> +<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> *</em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @return a String of the ip address of the server that connected to send this message</em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> */</em> +<a name="99" href="#99">99</a> String getRemoteAddr(); +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * The error message, if any, associated with this message. Not sure why this is needed.</em> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @return a String of a descriptive error message</em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em> +<a name="105" href="#105">105</a> String getErrorMessage(); +<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em> +<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Sets the error message associated with this message. Not sure why this is needed.</em> +<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> *</em> +<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @param msg - a descriptive error message</em> +<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> */</em> +<a name="111" href="#111">111</a> <strong class="jxr_keyword">void</strong> setErrorMessage(String msg); +<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em> +<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Sets the MimeMessage associated with this message via the object.</em> +<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> *</em> +<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @param message - the new MimeMessage that this Mail object will wrap</em> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em> +<a name="117" href="#117">117</a> <strong class="jxr_keyword">void</strong> setMessage(MimeMessage message); +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Sets the state of this message.</em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param state - the new state of this message</em> +<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em> +<a name="123" href="#123">123</a> <strong class="jxr_keyword">void</strong> setState(String state); +<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em> +<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * Returns the Mail session attribute with the given name, or null</em> +<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * if there is no attribute by that name.</em> +<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * An attribute allows a mailet to give this Mail instance additional information</em> +<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * not already provided by this interface.<p></em> +<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * A list of currently set attributes can be retrieved using getAttributeNames.</em> +<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * The attribute is returned as a java.lang.Object or some subclass. Attribute</em> +<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * names should follow the same convention as package names. The Mailet API</em> +<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * specification reserves names matching <I>org.apache.james.*</I></em> +<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * and <I>org.apache.mailet.*</I>.</em> +<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> *</em> +<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @param name - a String specifying the name of the attribute</em> +<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @return an Object containing the value of the attribute, or null if no attribute</em> +<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * exists matching the given name</em> +<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.1</em> +<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> +<a name="141" href="#141">141</a> Serializable getAttribute(String name); +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Returns an Iterator containing the attribute names currently available within</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * this Mail instance. Use the getAttribute(java.lang.String) method with an</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * attribute name to get the value of an attribute.</em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> *</em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @return an Iterator of attribute names</em> +<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.1</em> +<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em> +<a name="150" href="#150">150</a> Iterator getAttributeNames(); +<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em> +<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @return true if this Mail instance has any attributes set.</em> +<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.1</em> +<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> **/</em> +<a name="155" href="#155">155</a> <strong class="jxr_keyword">boolean</strong> hasAttributes(); +<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em> +<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * Removes the attribute with the given name from this Mail instance. After</em> +<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * removal, subsequent calls to getAttribute(java.lang.String) to retrieve</em> +<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * the attribute's value will return null.</em> +<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> *</em> +<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param name - a String specifying the name of the attribute to be removed</em> +<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @return previous attribute value associated with specified name, or null</em> +<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * if there was no mapping for name (null can also mean that null</em> +<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * was bound to the name)</em> +<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.1</em> +<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em> +<a name="167" href="#167">167</a> Serializable removeAttribute(String name); +<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">/**</em> +<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * Removes all the attributes associated with this Mail instance. </em> +<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.1</em> +<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> **/</em> +<a name="172" href="#172">172</a> <strong class="jxr_keyword">void</strong> removeAllAttributes(); +<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em> +<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * Binds an object to a given attribute name in this Mail instance. If the name</em> +<a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * specified is already used for an attribute, this method will remove the old</em> +<a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * attribute and bind the name to the new attribute.</em> +<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * As instances of Mail is Serializable, it is necessary that the attributes being</em> +<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * Serializable as well</em> +<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * Attribute names should follow the same convention as package names.</em> +<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * The Mailet API specification reserves names matching <I>org.apache.james.*</I></em> +<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * and <I>org.apache.mailet.*</I>.</em> +<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> *</em> +<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * @param name - a String specifying the name of the attribute</em> +<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * @param object - a Serializable Object representing the attribute to be bound</em> +<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * @return the object previously bound to the name, null if the name was</em> +<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * not bound (null can also mean that null was bound to the name)</em> +<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.1</em> +<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> */</em> +<a name="190" href="#190">190</a> Serializable setAttribute(String name, Serializable object); +<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">/**</em> +<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * @return message size</em> +<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.3</em> +<a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> */</em> +<a name="195" href="#195">195</a> <strong class="jxr_keyword">long</strong> getMessageSize() <strong class="jxr_keyword">throws</strong> MessagingException; +<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">/**</em> +<a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * @return the last update date</em> +<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.3</em> +<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> */</em> +<a name="200" href="#200">200</a> Date getLastUpdated(); +<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">/**</em> +<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * @param lastUpdated the new last updated date</em> +<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * @since Mailet API v2.3</em> +<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> */</em> +<a name="205" href="#205">205</a> <strong class="jxr_keyword">void</strong> setLastUpdated(Date lastUpdated); +<a name="206" href="#206">206</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> +</html> +
