commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t.@apache.org
Subject svn commit: r852848 [19/22] - in /websites/production/commons/content/proper/commons-email/javadocs/api-release: ./ org/ org/apache/ org/apache/commons/ org/apache/commons/mail/ org/apache/commons/mail/class-use/ org/apache/commons/mail/resolver/ org/a...
Date Sun, 03 Mar 2013 22:09:57 GMT
Added: websites/production/commons/content/proper/commons-email/javadocs/api-release/src-html/org/apache/commons/mail/HtmlEmail.html
==============================================================================
--- websites/production/commons/content/proper/commons-email/javadocs/api-release/src-html/org/apache/commons/mail/HtmlEmail.html (added)
+++ websites/production/commons/content/proper/commons-email/javadocs/api-release/src-html/org/apache/commons/mail/HtmlEmail.html Sun Mar  3 22:09:55 2013
@@ -0,0 +1,784 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.mail;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import java.io.InputStream;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import java.io.UnsupportedEncodingException;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import java.net.MalformedURLException;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import java.net.URL;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import java.util.HashMap;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import java.util.Iterator;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import java.util.Locale;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a>
+<span class="sourceLineNo">030</span><a name="line.30"></a>
+<span class="sourceLineNo">031</span>import javax.activation.DataHandler;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import javax.activation.DataSource;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import javax.activation.FileDataSource;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import javax.activation.URLDataSource;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import javax.mail.BodyPart;<a name="line.35"></a>
+<span class="sourceLineNo">036</span>import javax.mail.MessagingException;<a name="line.36"></a>
+<span class="sourceLineNo">037</span>import javax.mail.internet.MimeBodyPart;<a name="line.37"></a>
+<span class="sourceLineNo">038</span>import javax.mail.internet.MimeMultipart;<a name="line.38"></a>
+<span class="sourceLineNo">039</span><a name="line.39"></a>
+<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * An HTML multipart email.<a name="line.41"></a>
+<span class="sourceLineNo">042</span> *<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * &lt;p&gt;This class is used to send HTML formatted email.  A text message<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * can also be set for HTML unaware email clients, such as text-based<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * email clients.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> *<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * &lt;p&gt;This class also inherits from {@link MultiPartEmail}, so it is easy to<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * add attachments to the email.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> *<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * &lt;p&gt;To send an email in HTML, one should create a &lt;code&gt;HtmlEmail&lt;/code&gt;, then<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * use the {@link #setFrom(String)}, {@link #addTo(String)} etc. methods.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * The HTML content can be set with the {@link #setHtmlMsg(String)} method. The<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * alternative text content can be set with {@link #setTextMsg(String)}.<a name="line.53"></a>
+<span class="sourceLineNo">054</span> *<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * &lt;p&gt;Either the text or HTML can be omitted, in which case the "main"<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * part of the multipart becomes whichever is supplied rather than a<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * &lt;code&gt;multipart/alternative&lt;/code&gt;.<a name="line.57"></a>
+<span class="sourceLineNo">058</span> *<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * &lt;h3&gt;Embedding Images and Media&lt;/h3&gt;<a name="line.59"></a>
+<span class="sourceLineNo">060</span> *<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * &lt;p&gt;It is also possible to embed URLs, files, or arbitrary<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * &lt;code&gt;DataSource&lt;/code&gt;s directly into the body of the mail:<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * &lt;pre&gt;&lt;code&gt;<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * HtmlEmail he = new HtmlEmail();<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * File img = new File("my/image.gif");<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * PNGDataSource png = new PNGDataSource(decodedPNGOutputStream); // a custom class<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * StringBuffer msg = new StringBuffer();<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * msg.append("&amp;lt;html&amp;gt;&amp;lt;body&amp;gt;");<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * msg.append("&amp;lt;img src=cid:").append(he.embed(img)).append("&amp;gt;");<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * msg.append("&amp;lt;img src=cid:").append(he.embed(png)).append("&amp;gt;");<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * msg.append("&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;");<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * he.setHtmlMsg(msg.toString());<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * // code to set the other email fields (not shown)<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * &lt;/pre&gt;&lt;/code&gt;<a name="line.74"></a>
+<span class="sourceLineNo">075</span> *<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * &lt;p&gt;Embedded entities are tracked by their name, which for &lt;code&gt;File&lt;/code&gt;s is<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * the filename itself and for &lt;code&gt;URL&lt;/code&gt;s is the canonical path. It is<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * an error to bind the same name to more than one entity, and this class will<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * attempt to validate that for &lt;code&gt;File&lt;/code&gt;s and &lt;code&gt;URL&lt;/code&gt;s. When<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * embedding a &lt;code&gt;DataSource&lt;/code&gt;, the code uses the &lt;code&gt;equals()&lt;/code&gt;<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * method defined on the &lt;code&gt;DataSource&lt;/code&gt;s to make the determination.<a name="line.81"></a>
+<span class="sourceLineNo">082</span> *<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * @since 1.0<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * @author &lt;a href="mailto:unknown"&gt;Regis Koenig&lt;/a&gt;<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * @author &lt;a href="mailto:sean@informage.net"&gt;Sean Legassick&lt;/a&gt;<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * @version $Id$<a name="line.86"></a>
+<span class="sourceLineNo">087</span> */<a name="line.87"></a>
+<span class="sourceLineNo">088</span>public class HtmlEmail extends MultiPartEmail<a name="line.88"></a>
+<span class="sourceLineNo">089</span>{<a name="line.89"></a>
+<span class="sourceLineNo">090</span>    /** Definition of the length of generated CID's. */<a name="line.90"></a>
+<span class="sourceLineNo">091</span>    public static final int CID_LENGTH = 10;<a name="line.91"></a>
+<span class="sourceLineNo">092</span><a name="line.92"></a>
+<span class="sourceLineNo">093</span>    /** prefix for default HTML mail. */<a name="line.93"></a>
+<span class="sourceLineNo">094</span>    private static final String HTML_MESSAGE_START = "&lt;html&gt;&lt;body&gt;&lt;pre&gt;";<a name="line.94"></a>
+<span class="sourceLineNo">095</span>    /** suffix for default HTML mail. */<a name="line.95"></a>
+<span class="sourceLineNo">096</span>    private static final String HTML_MESSAGE_END = "&lt;/pre&gt;&lt;/body&gt;&lt;/html&gt;";<a name="line.96"></a>
+<span class="sourceLineNo">097</span><a name="line.97"></a>
+<span class="sourceLineNo">098</span><a name="line.98"></a>
+<span class="sourceLineNo">099</span>    /**<a name="line.99"></a>
+<span class="sourceLineNo">100</span>     * Text part of the message. This will be used as alternative text if<a name="line.100"></a>
+<span class="sourceLineNo">101</span>     * the email client does not support HTML messages.<a name="line.101"></a>
+<span class="sourceLineNo">102</span>     */<a name="line.102"></a>
+<span class="sourceLineNo">103</span>    protected String text;<a name="line.103"></a>
+<span class="sourceLineNo">104</span><a name="line.104"></a>
+<span class="sourceLineNo">105</span>    /** Html part of the message. */<a name="line.105"></a>
+<span class="sourceLineNo">106</span>    protected String html;<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
+<span class="sourceLineNo">109</span>     * @deprecated As of commons-email 1.1, no longer used. Inline embedded<a name="line.109"></a>
+<span class="sourceLineNo">110</span>     * objects are now stored in {@link #inlineEmbeds}.<a name="line.110"></a>
+<span class="sourceLineNo">111</span>     */<a name="line.111"></a>
+<span class="sourceLineNo">112</span>    @Deprecated<a name="line.112"></a>
+<span class="sourceLineNo">113</span>    protected List&lt;InlineImage&gt; inlineImages;<a name="line.113"></a>
+<span class="sourceLineNo">114</span><a name="line.114"></a>
+<span class="sourceLineNo">115</span>    /**<a name="line.115"></a>
+<span class="sourceLineNo">116</span>     * Embedded images Map&lt;String, InlineImage&gt; where the key is the<a name="line.116"></a>
+<span class="sourceLineNo">117</span>     * user-defined image name.<a name="line.117"></a>
+<span class="sourceLineNo">118</span>     */<a name="line.118"></a>
+<span class="sourceLineNo">119</span>    protected Map&lt;String, InlineImage&gt; inlineEmbeds = new HashMap&lt;String, InlineImage&gt;();<a name="line.119"></a>
+<span class="sourceLineNo">120</span><a name="line.120"></a>
+<span class="sourceLineNo">121</span>    /**<a name="line.121"></a>
+<span class="sourceLineNo">122</span>     * Set the text content.<a name="line.122"></a>
+<span class="sourceLineNo">123</span>     *<a name="line.123"></a>
+<span class="sourceLineNo">124</span>     * @param aText A String.<a name="line.124"></a>
+<span class="sourceLineNo">125</span>     * @return An HtmlEmail.<a name="line.125"></a>
+<span class="sourceLineNo">126</span>     * @throws EmailException see javax.mail.internet.MimeBodyPart<a name="line.126"></a>
+<span class="sourceLineNo">127</span>     *  for definitions<a name="line.127"></a>
+<span class="sourceLineNo">128</span>     * @since 1.0<a name="line.128"></a>
+<span class="sourceLineNo">129</span>     */<a name="line.129"></a>
+<span class="sourceLineNo">130</span>    public HtmlEmail setTextMsg(String aText) throws EmailException<a name="line.130"></a>
+<span class="sourceLineNo">131</span>    {<a name="line.131"></a>
+<span class="sourceLineNo">132</span>        if (EmailUtils.isEmpty(aText))<a name="line.132"></a>
+<span class="sourceLineNo">133</span>        {<a name="line.133"></a>
+<span class="sourceLineNo">134</span>            throw new EmailException("Invalid message supplied");<a name="line.134"></a>
+<span class="sourceLineNo">135</span>        }<a name="line.135"></a>
+<span class="sourceLineNo">136</span><a name="line.136"></a>
+<span class="sourceLineNo">137</span>        this.text = aText;<a name="line.137"></a>
+<span class="sourceLineNo">138</span>        return this;<a name="line.138"></a>
+<span class="sourceLineNo">139</span>    }<a name="line.139"></a>
+<span class="sourceLineNo">140</span><a name="line.140"></a>
+<span class="sourceLineNo">141</span>    /**<a name="line.141"></a>
+<span class="sourceLineNo">142</span>     * Set the HTML content.<a name="line.142"></a>
+<span class="sourceLineNo">143</span>     *<a name="line.143"></a>
+<span class="sourceLineNo">144</span>     * @param aHtml A String.<a name="line.144"></a>
+<span class="sourceLineNo">145</span>     * @return An HtmlEmail.<a name="line.145"></a>
+<span class="sourceLineNo">146</span>     * @throws EmailException see javax.mail.internet.MimeBodyPart<a name="line.146"></a>
+<span class="sourceLineNo">147</span>     *  for definitions<a name="line.147"></a>
+<span class="sourceLineNo">148</span>     * @since 1.0<a name="line.148"></a>
+<span class="sourceLineNo">149</span>     */<a name="line.149"></a>
+<span class="sourceLineNo">150</span>    public HtmlEmail setHtmlMsg(String aHtml) throws EmailException<a name="line.150"></a>
+<span class="sourceLineNo">151</span>    {<a name="line.151"></a>
+<span class="sourceLineNo">152</span>        if (EmailUtils.isEmpty(aHtml))<a name="line.152"></a>
+<span class="sourceLineNo">153</span>        {<a name="line.153"></a>
+<span class="sourceLineNo">154</span>            throw new EmailException("Invalid message supplied");<a name="line.154"></a>
+<span class="sourceLineNo">155</span>        }<a name="line.155"></a>
+<span class="sourceLineNo">156</span><a name="line.156"></a>
+<span class="sourceLineNo">157</span>        this.html = aHtml;<a name="line.157"></a>
+<span class="sourceLineNo">158</span>        return this;<a name="line.158"></a>
+<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
+<span class="sourceLineNo">160</span><a name="line.160"></a>
+<span class="sourceLineNo">161</span>    /**<a name="line.161"></a>
+<span class="sourceLineNo">162</span>     * Set the message.<a name="line.162"></a>
+<span class="sourceLineNo">163</span>     *<a name="line.163"></a>
+<span class="sourceLineNo">164</span>     * &lt;p&gt;This method overrides {@link MultiPartEmail#setMsg(String)} in<a name="line.164"></a>
+<span class="sourceLineNo">165</span>     * order to send an HTML message instead of a plain text message in<a name="line.165"></a>
+<span class="sourceLineNo">166</span>     * the mail body. The message is formatted in HTML for the HTML<a name="line.166"></a>
+<span class="sourceLineNo">167</span>     * part of the message; it is left as is in the alternate text<a name="line.167"></a>
+<span class="sourceLineNo">168</span>     * part.<a name="line.168"></a>
+<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
+<span class="sourceLineNo">170</span>     * @param msg the message text to use<a name="line.170"></a>
+<span class="sourceLineNo">171</span>     * @return this &lt;code&gt;HtmlEmail&lt;/code&gt;<a name="line.171"></a>
+<span class="sourceLineNo">172</span>     * @throws EmailException if msg is null or empty;<a name="line.172"></a>
+<span class="sourceLineNo">173</span>     * see javax.mail.internet.MimeBodyPart for definitions<a name="line.173"></a>
+<span class="sourceLineNo">174</span>     * @since 1.0<a name="line.174"></a>
+<span class="sourceLineNo">175</span>     */<a name="line.175"></a>
+<span class="sourceLineNo">176</span>    @Override<a name="line.176"></a>
+<span class="sourceLineNo">177</span>    public Email setMsg(String msg) throws EmailException<a name="line.177"></a>
+<span class="sourceLineNo">178</span>    {<a name="line.178"></a>
+<span class="sourceLineNo">179</span>        if (EmailUtils.isEmpty(msg))<a name="line.179"></a>
+<span class="sourceLineNo">180</span>        {<a name="line.180"></a>
+<span class="sourceLineNo">181</span>            throw new EmailException("Invalid message supplied");<a name="line.181"></a>
+<span class="sourceLineNo">182</span>        }<a name="line.182"></a>
+<span class="sourceLineNo">183</span><a name="line.183"></a>
+<span class="sourceLineNo">184</span>        setTextMsg(msg);<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span>        StringBuffer htmlMsgBuf = new StringBuffer(<a name="line.186"></a>
+<span class="sourceLineNo">187</span>            msg.length()<a name="line.187"></a>
+<span class="sourceLineNo">188</span>            + HTML_MESSAGE_START.length()<a name="line.188"></a>
+<span class="sourceLineNo">189</span>            + HTML_MESSAGE_END.length()<a name="line.189"></a>
+<span class="sourceLineNo">190</span>        );<a name="line.190"></a>
+<span class="sourceLineNo">191</span><a name="line.191"></a>
+<span class="sourceLineNo">192</span>        htmlMsgBuf.append(HTML_MESSAGE_START)<a name="line.192"></a>
+<span class="sourceLineNo">193</span>            .append(msg)<a name="line.193"></a>
+<span class="sourceLineNo">194</span>            .append(HTML_MESSAGE_END);<a name="line.194"></a>
+<span class="sourceLineNo">195</span><a name="line.195"></a>
+<span class="sourceLineNo">196</span>        setHtmlMsg(htmlMsgBuf.toString());<a name="line.196"></a>
+<span class="sourceLineNo">197</span><a name="line.197"></a>
+<span class="sourceLineNo">198</span>        return this;<a name="line.198"></a>
+<span class="sourceLineNo">199</span>    }<a name="line.199"></a>
+<span class="sourceLineNo">200</span><a name="line.200"></a>
+<span class="sourceLineNo">201</span>    /**<a name="line.201"></a>
+<span class="sourceLineNo">202</span>     * Attempts to parse the specified &lt;code&gt;String&lt;/code&gt; as a URL that will<a name="line.202"></a>
+<span class="sourceLineNo">203</span>     * then be embedded in the message.<a name="line.203"></a>
+<span class="sourceLineNo">204</span>     *<a name="line.204"></a>
+<span class="sourceLineNo">205</span>     * @param urlString String representation of the URL.<a name="line.205"></a>
+<span class="sourceLineNo">206</span>     * @param name The name that will be set in the filename header field.<a name="line.206"></a>
+<span class="sourceLineNo">207</span>     * @return A String with the Content-ID of the URL.<a name="line.207"></a>
+<span class="sourceLineNo">208</span>     * @throws EmailException when URL supplied is invalid or if {@code name} is null<a name="line.208"></a>
+<span class="sourceLineNo">209</span>     * or empty; also see {@link javax.mail.internet.MimeBodyPart} for definitions<a name="line.209"></a>
+<span class="sourceLineNo">210</span>     *<a name="line.210"></a>
+<span class="sourceLineNo">211</span>     * @see #embed(URL, String)<a name="line.211"></a>
+<span class="sourceLineNo">212</span>     * @since 1.1<a name="line.212"></a>
+<span class="sourceLineNo">213</span>     */<a name="line.213"></a>
+<span class="sourceLineNo">214</span>    public String embed(String urlString, String name) throws EmailException<a name="line.214"></a>
+<span class="sourceLineNo">215</span>    {<a name="line.215"></a>
+<span class="sourceLineNo">216</span>        try<a name="line.216"></a>
+<span class="sourceLineNo">217</span>        {<a name="line.217"></a>
+<span class="sourceLineNo">218</span>            return embed(new URL(urlString), name);<a name="line.218"></a>
+<span class="sourceLineNo">219</span>        }<a name="line.219"></a>
+<span class="sourceLineNo">220</span>        catch (MalformedURLException e)<a name="line.220"></a>
+<span class="sourceLineNo">221</span>        {<a name="line.221"></a>
+<span class="sourceLineNo">222</span>            throw new EmailException("Invalid URL", e);<a name="line.222"></a>
+<span class="sourceLineNo">223</span>        }<a name="line.223"></a>
+<span class="sourceLineNo">224</span>    }<a name="line.224"></a>
+<span class="sourceLineNo">225</span><a name="line.225"></a>
+<span class="sourceLineNo">226</span>    /**<a name="line.226"></a>
+<span class="sourceLineNo">227</span>     * Embeds an URL in the HTML.<a name="line.227"></a>
+<span class="sourceLineNo">228</span>     *<a name="line.228"></a>
+<span class="sourceLineNo">229</span>     * &lt;p&gt;This method embeds a file located by an URL into<a name="line.229"></a>
+<span class="sourceLineNo">230</span>     * the mail body. It allows, for instance, to add inline images<a name="line.230"></a>
+<span class="sourceLineNo">231</span>     * to the email.  Inline files may be referenced with a<a name="line.231"></a>
+<span class="sourceLineNo">232</span>     * &lt;code&gt;cid:xxxxxx&lt;/code&gt; URL, where xxxxxx is the Content-ID<a name="line.232"></a>
+<span class="sourceLineNo">233</span>     * returned by the embed function. It is an error to bind the same name<a name="line.233"></a>
+<span class="sourceLineNo">234</span>     * to more than one URL; if the same URL is embedded multiple times, the<a name="line.234"></a>
+<span class="sourceLineNo">235</span>     * same Content-ID is guaranteed to be returned.<a name="line.235"></a>
+<span class="sourceLineNo">236</span>     *<a name="line.236"></a>
+<span class="sourceLineNo">237</span>     * &lt;p&gt;While functionally the same as passing &lt;code&gt;URLDataSource&lt;/code&gt; to<a name="line.237"></a>
+<span class="sourceLineNo">238</span>     * {@link #embed(DataSource, String, String)}, this method attempts<a name="line.238"></a>
+<span class="sourceLineNo">239</span>     * to validate the URL before embedding it in the message and will throw<a name="line.239"></a>
+<span class="sourceLineNo">240</span>     * &lt;code&gt;EmailException&lt;/code&gt; if the validation fails. In this case, the<a name="line.240"></a>
+<span class="sourceLineNo">241</span>     * &lt;code&gt;HtmlEmail&lt;/code&gt; object will not be changed.<a name="line.241"></a>
+<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
+<span class="sourceLineNo">243</span>     * &lt;p&gt;<a name="line.243"></a>
+<span class="sourceLineNo">244</span>     * NOTE: Clients should take care to ensure that different URLs are bound to<a name="line.244"></a>
+<span class="sourceLineNo">245</span>     * different names. This implementation tries to detect this and throw<a name="line.245"></a>
+<span class="sourceLineNo">246</span>     * &lt;code&gt;EmailException&lt;/code&gt;. However, it is not guaranteed to catch<a name="line.246"></a>
+<span class="sourceLineNo">247</span>     * all cases, especially when the URL refers to a remote HTTP host that<a name="line.247"></a>
+<span class="sourceLineNo">248</span>     * may be part of a virtual host cluster.<a name="line.248"></a>
+<span class="sourceLineNo">249</span>     *<a name="line.249"></a>
+<span class="sourceLineNo">250</span>     * @param url The URL of the file.<a name="line.250"></a>
+<span class="sourceLineNo">251</span>     * @param name The name that will be set in the filename header<a name="line.251"></a>
+<span class="sourceLineNo">252</span>     * field.<a name="line.252"></a>
+<span class="sourceLineNo">253</span>     * @return A String with the Content-ID of the file.<a name="line.253"></a>
+<span class="sourceLineNo">254</span>     * @throws EmailException when URL supplied is invalid or if {@code name} is null<a name="line.254"></a>
+<span class="sourceLineNo">255</span>     * or empty; also see {@link javax.mail.internet.MimeBodyPart} for definitions<a name="line.255"></a>
+<span class="sourceLineNo">256</span>     * @since 1.0<a name="line.256"></a>
+<span class="sourceLineNo">257</span>     */<a name="line.257"></a>
+<span class="sourceLineNo">258</span>    public String embed(URL url, String name) throws EmailException<a name="line.258"></a>
+<span class="sourceLineNo">259</span>    {<a name="line.259"></a>
+<span class="sourceLineNo">260</span>        if (EmailUtils.isEmpty(name))<a name="line.260"></a>
+<span class="sourceLineNo">261</span>        {<a name="line.261"></a>
+<span class="sourceLineNo">262</span>            throw new EmailException("name cannot be null or empty");<a name="line.262"></a>
+<span class="sourceLineNo">263</span>        }<a name="line.263"></a>
+<span class="sourceLineNo">264</span><a name="line.264"></a>
+<span class="sourceLineNo">265</span>        // check if a URLDataSource for this name has already been attached;<a name="line.265"></a>
+<span class="sourceLineNo">266</span>        // if so, return the cached CID value.<a name="line.266"></a>
+<span class="sourceLineNo">267</span>        if (inlineEmbeds.containsKey(name))<a name="line.267"></a>
+<span class="sourceLineNo">268</span>        {<a name="line.268"></a>
+<span class="sourceLineNo">269</span>            InlineImage ii = inlineEmbeds.get(name);<a name="line.269"></a>
+<span class="sourceLineNo">270</span>            URLDataSource urlDataSource = (URLDataSource) ii.getDataSource();<a name="line.270"></a>
+<span class="sourceLineNo">271</span>            // make sure the supplied URL points to the same thing<a name="line.271"></a>
+<span class="sourceLineNo">272</span>            // as the one already associated with this name.<a name="line.272"></a>
+<span class="sourceLineNo">273</span>            // NOTE: Comparing URLs with URL.equals() is a blocking operation<a name="line.273"></a>
+<span class="sourceLineNo">274</span>            // in the case of a network failure therefore we use<a name="line.274"></a>
+<span class="sourceLineNo">275</span>            // url.toExternalForm().equals() here.<a name="line.275"></a>
+<span class="sourceLineNo">276</span>            if (url.toExternalForm().equals(urlDataSource.getURL().toExternalForm()))<a name="line.276"></a>
+<span class="sourceLineNo">277</span>            {<a name="line.277"></a>
+<span class="sourceLineNo">278</span>                return ii.getCid();<a name="line.278"></a>
+<span class="sourceLineNo">279</span>            }<a name="line.279"></a>
+<span class="sourceLineNo">280</span>            else<a name="line.280"></a>
+<span class="sourceLineNo">281</span>            {<a name="line.281"></a>
+<span class="sourceLineNo">282</span>                throw new EmailException("embedded name '" + name<a name="line.282"></a>
+<span class="sourceLineNo">283</span>                    + "' is already bound to URL " + urlDataSource.getURL()<a name="line.283"></a>
+<span class="sourceLineNo">284</span>                    + "; existing names cannot be rebound");<a name="line.284"></a>
+<span class="sourceLineNo">285</span>            }<a name="line.285"></a>
+<span class="sourceLineNo">286</span>        }<a name="line.286"></a>
+<span class="sourceLineNo">287</span><a name="line.287"></a>
+<span class="sourceLineNo">288</span>        // verify that the URL is valid<a name="line.288"></a>
+<span class="sourceLineNo">289</span>        InputStream is = null;<a name="line.289"></a>
+<span class="sourceLineNo">290</span>        try<a name="line.290"></a>
+<span class="sourceLineNo">291</span>        {<a name="line.291"></a>
+<span class="sourceLineNo">292</span>            is = url.openStream();<a name="line.292"></a>
+<span class="sourceLineNo">293</span>        }<a name="line.293"></a>
+<span class="sourceLineNo">294</span>        catch (IOException e)<a name="line.294"></a>
+<span class="sourceLineNo">295</span>        {<a name="line.295"></a>
+<span class="sourceLineNo">296</span>            throw new EmailException("Invalid URL", e);<a name="line.296"></a>
+<span class="sourceLineNo">297</span>        }<a name="line.297"></a>
+<span class="sourceLineNo">298</span>        finally<a name="line.298"></a>
+<span class="sourceLineNo">299</span>        {<a name="line.299"></a>
+<span class="sourceLineNo">300</span>            try<a name="line.300"></a>
+<span class="sourceLineNo">301</span>            {<a name="line.301"></a>
+<span class="sourceLineNo">302</span>                if (is != null)<a name="line.302"></a>
+<span class="sourceLineNo">303</span>                {<a name="line.303"></a>
+<span class="sourceLineNo">304</span>                    is.close();<a name="line.304"></a>
+<span class="sourceLineNo">305</span>                }<a name="line.305"></a>
+<span class="sourceLineNo">306</span>            }<a name="line.306"></a>
+<span class="sourceLineNo">307</span>            catch (IOException ioe) // NOPMD<a name="line.307"></a>
+<span class="sourceLineNo">308</span>            { /* sigh */ }<a name="line.308"></a>
+<span class="sourceLineNo">309</span>        }<a name="line.309"></a>
+<span class="sourceLineNo">310</span><a name="line.310"></a>
+<span class="sourceLineNo">311</span>        return embed(new URLDataSource(url), name);<a name="line.311"></a>
+<span class="sourceLineNo">312</span>    }<a name="line.312"></a>
+<span class="sourceLineNo">313</span><a name="line.313"></a>
+<span class="sourceLineNo">314</span>    /**<a name="line.314"></a>
+<span class="sourceLineNo">315</span>     * Embeds a file in the HTML. This implementation delegates to<a name="line.315"></a>
+<span class="sourceLineNo">316</span>     * {@link #embed(File, String)}.<a name="line.316"></a>
+<span class="sourceLineNo">317</span>     *<a name="line.317"></a>
+<span class="sourceLineNo">318</span>     * @param file The &lt;code&gt;File&lt;/code&gt; object to embed<a name="line.318"></a>
+<span class="sourceLineNo">319</span>     * @return A String with the Content-ID of the file.<a name="line.319"></a>
+<span class="sourceLineNo">320</span>     * @throws EmailException when the supplied &lt;code&gt;File&lt;/code&gt; cannot be<a name="line.320"></a>
+<span class="sourceLineNo">321</span>     * used; also see {@link javax.mail.internet.MimeBodyPart} for definitions<a name="line.321"></a>
+<span class="sourceLineNo">322</span>     *<a name="line.322"></a>
+<span class="sourceLineNo">323</span>     * @see #embed(File, String)<a name="line.323"></a>
+<span class="sourceLineNo">324</span>     * @since 1.1<a name="line.324"></a>
+<span class="sourceLineNo">325</span>     */<a name="line.325"></a>
+<span class="sourceLineNo">326</span>    public String embed(File file) throws EmailException<a name="line.326"></a>
+<span class="sourceLineNo">327</span>    {<a name="line.327"></a>
+<span class="sourceLineNo">328</span>        String cid = EmailUtils.randomAlphabetic(HtmlEmail.CID_LENGTH).toLowerCase(Locale.ENGLISH);<a name="line.328"></a>
+<span class="sourceLineNo">329</span>        return embed(file, cid);<a name="line.329"></a>
+<span class="sourceLineNo">330</span>    }<a name="line.330"></a>
+<span class="sourceLineNo">331</span><a name="line.331"></a>
+<span class="sourceLineNo">332</span>    /**<a name="line.332"></a>
+<span class="sourceLineNo">333</span>     * Embeds a file in the HTML.<a name="line.333"></a>
+<span class="sourceLineNo">334</span>     *<a name="line.334"></a>
+<span class="sourceLineNo">335</span>     * &lt;p&gt;This method embeds a file located by an URL into<a name="line.335"></a>
+<span class="sourceLineNo">336</span>     * the mail body. It allows, for instance, to add inline images<a name="line.336"></a>
+<span class="sourceLineNo">337</span>     * to the email.  Inline files may be referenced with a<a name="line.337"></a>
+<span class="sourceLineNo">338</span>     * &lt;code&gt;cid:xxxxxx&lt;/code&gt; URL, where xxxxxx is the Content-ID<a name="line.338"></a>
+<span class="sourceLineNo">339</span>     * returned by the embed function. Files are bound to their names, which is<a name="line.339"></a>
+<span class="sourceLineNo">340</span>     * the value returned by {@link java.io.File#getName()}. If the same file<a name="line.340"></a>
+<span class="sourceLineNo">341</span>     * is embedded multiple times, the same CID is guaranteed to be returned.<a name="line.341"></a>
+<span class="sourceLineNo">342</span>     *<a name="line.342"></a>
+<span class="sourceLineNo">343</span>     * &lt;p&gt;While functionally the same as passing &lt;code&gt;FileDataSource&lt;/code&gt; to<a name="line.343"></a>
+<span class="sourceLineNo">344</span>     * {@link #embed(DataSource, String, String)}, this method attempts<a name="line.344"></a>
+<span class="sourceLineNo">345</span>     * to validate the file before embedding it in the message and will throw<a name="line.345"></a>
+<span class="sourceLineNo">346</span>     * &lt;code&gt;EmailException&lt;/code&gt; if the validation fails. In this case, the<a name="line.346"></a>
+<span class="sourceLineNo">347</span>     * &lt;code&gt;HtmlEmail&lt;/code&gt; object will not be changed.<a name="line.347"></a>
+<span class="sourceLineNo">348</span>     *<a name="line.348"></a>
+<span class="sourceLineNo">349</span>     * @param file The &lt;code&gt;File&lt;/code&gt; to embed<a name="line.349"></a>
+<span class="sourceLineNo">350</span>     * @param cid the Content-ID to use for the embedded &lt;code&gt;File&lt;/code&gt;<a name="line.350"></a>
+<span class="sourceLineNo">351</span>     * @return A String with the Content-ID of the file.<a name="line.351"></a>
+<span class="sourceLineNo">352</span>     * @throws EmailException when the supplied &lt;code&gt;File&lt;/code&gt; cannot be used<a name="line.352"></a>
+<span class="sourceLineNo">353</span>     *  or if the file has already been embedded;<a name="line.353"></a>
+<span class="sourceLineNo">354</span>     *  also see {@link javax.mail.internet.MimeBodyPart} for definitions<a name="line.354"></a>
+<span class="sourceLineNo">355</span>     * @since 1.1<a name="line.355"></a>
+<span class="sourceLineNo">356</span>     */<a name="line.356"></a>
+<span class="sourceLineNo">357</span>    public String embed(File file, String cid) throws EmailException<a name="line.357"></a>
+<span class="sourceLineNo">358</span>    {<a name="line.358"></a>
+<span class="sourceLineNo">359</span>        if (EmailUtils.isEmpty(file.getName()))<a name="line.359"></a>
+<span class="sourceLineNo">360</span>        {<a name="line.360"></a>
+<span class="sourceLineNo">361</span>            throw new EmailException("file name cannot be null or empty");<a name="line.361"></a>
+<span class="sourceLineNo">362</span>        }<a name="line.362"></a>
+<span class="sourceLineNo">363</span><a name="line.363"></a>
+<span class="sourceLineNo">364</span>        // verify that the File can provide a canonical path<a name="line.364"></a>
+<span class="sourceLineNo">365</span>        String filePath = null;<a name="line.365"></a>
+<span class="sourceLineNo">366</span>        try<a name="line.366"></a>
+<span class="sourceLineNo">367</span>        {<a name="line.367"></a>
+<span class="sourceLineNo">368</span>            filePath = file.getCanonicalPath();<a name="line.368"></a>
+<span class="sourceLineNo">369</span>        }<a name="line.369"></a>
+<span class="sourceLineNo">370</span>        catch (IOException ioe)<a name="line.370"></a>
+<span class="sourceLineNo">371</span>        {<a name="line.371"></a>
+<span class="sourceLineNo">372</span>            throw new EmailException("couldn't get canonical path for "<a name="line.372"></a>
+<span class="sourceLineNo">373</span>                    + file.getName(), ioe);<a name="line.373"></a>
+<span class="sourceLineNo">374</span>        }<a name="line.374"></a>
+<span class="sourceLineNo">375</span><a name="line.375"></a>
+<span class="sourceLineNo">376</span>        // check if a FileDataSource for this name has already been attached;<a name="line.376"></a>
+<span class="sourceLineNo">377</span>        // if so, return the cached CID value.<a name="line.377"></a>
+<span class="sourceLineNo">378</span>        if (inlineEmbeds.containsKey(file.getName()))<a name="line.378"></a>
+<span class="sourceLineNo">379</span>        {<a name="line.379"></a>
+<span class="sourceLineNo">380</span>            InlineImage ii = inlineEmbeds.get(file.getName());<a name="line.380"></a>
+<span class="sourceLineNo">381</span>            FileDataSource fileDataSource = (FileDataSource) ii.getDataSource();<a name="line.381"></a>
+<span class="sourceLineNo">382</span>            // make sure the supplied file has the same canonical path<a name="line.382"></a>
+<span class="sourceLineNo">383</span>            // as the one already associated with this name.<a name="line.383"></a>
+<span class="sourceLineNo">384</span>            String existingFilePath = null;<a name="line.384"></a>
+<span class="sourceLineNo">385</span>            try<a name="line.385"></a>
+<span class="sourceLineNo">386</span>            {<a name="line.386"></a>
+<span class="sourceLineNo">387</span>                existingFilePath = fileDataSource.getFile().getCanonicalPath();<a name="line.387"></a>
+<span class="sourceLineNo">388</span>            }<a name="line.388"></a>
+<span class="sourceLineNo">389</span>            catch (IOException ioe)<a name="line.389"></a>
+<span class="sourceLineNo">390</span>            {<a name="line.390"></a>
+<span class="sourceLineNo">391</span>                throw new EmailException("couldn't get canonical path for file "<a name="line.391"></a>
+<span class="sourceLineNo">392</span>                        + fileDataSource.getFile().getName()<a name="line.392"></a>
+<span class="sourceLineNo">393</span>                        + "which has already been embedded", ioe);<a name="line.393"></a>
+<span class="sourceLineNo">394</span>            }<a name="line.394"></a>
+<span class="sourceLineNo">395</span>            if (filePath.equals(existingFilePath))<a name="line.395"></a>
+<span class="sourceLineNo">396</span>            {<a name="line.396"></a>
+<span class="sourceLineNo">397</span>                return ii.getCid();<a name="line.397"></a>
+<span class="sourceLineNo">398</span>            }<a name="line.398"></a>
+<span class="sourceLineNo">399</span>            else<a name="line.399"></a>
+<span class="sourceLineNo">400</span>            {<a name="line.400"></a>
+<span class="sourceLineNo">401</span>                throw new EmailException("embedded name '" + file.getName()<a name="line.401"></a>
+<span class="sourceLineNo">402</span>                    + "' is already bound to file " + existingFilePath<a name="line.402"></a>
+<span class="sourceLineNo">403</span>                    + "; existing names cannot be rebound");<a name="line.403"></a>
+<span class="sourceLineNo">404</span>            }<a name="line.404"></a>
+<span class="sourceLineNo">405</span>        }<a name="line.405"></a>
+<span class="sourceLineNo">406</span><a name="line.406"></a>
+<span class="sourceLineNo">407</span>        // verify that the file is valid<a name="line.407"></a>
+<span class="sourceLineNo">408</span>        if (!file.exists())<a name="line.408"></a>
+<span class="sourceLineNo">409</span>        {<a name="line.409"></a>
+<span class="sourceLineNo">410</span>            throw new EmailException("file " + filePath + " doesn't exist");<a name="line.410"></a>
+<span class="sourceLineNo">411</span>        }<a name="line.411"></a>
+<span class="sourceLineNo">412</span>        if (!file.isFile())<a name="line.412"></a>
+<span class="sourceLineNo">413</span>        {<a name="line.413"></a>
+<span class="sourceLineNo">414</span>            throw new EmailException("file " + filePath + " isn't a normal file");<a name="line.414"></a>
+<span class="sourceLineNo">415</span>        }<a name="line.415"></a>
+<span class="sourceLineNo">416</span>        if (!file.canRead())<a name="line.416"></a>
+<span class="sourceLineNo">417</span>        {<a name="line.417"></a>
+<span class="sourceLineNo">418</span>            throw new EmailException("file " + filePath + " isn't readable");<a name="line.418"></a>
+<span class="sourceLineNo">419</span>        }<a name="line.419"></a>
+<span class="sourceLineNo">420</span><a name="line.420"></a>
+<span class="sourceLineNo">421</span>        return embed(new FileDataSource(file), file.getName(), cid);<a name="line.421"></a>
+<span class="sourceLineNo">422</span>    }<a name="line.422"></a>
+<span class="sourceLineNo">423</span><a name="line.423"></a>
+<span class="sourceLineNo">424</span>    /**<a name="line.424"></a>
+<span class="sourceLineNo">425</span>     * Embeds the specified &lt;code&gt;DataSource&lt;/code&gt; in the HTML using a<a name="line.425"></a>
+<span class="sourceLineNo">426</span>     * randomly generated Content-ID. Returns the generated Content-ID string.<a name="line.426"></a>
+<span class="sourceLineNo">427</span>     *<a name="line.427"></a>
+<span class="sourceLineNo">428</span>     * @param dataSource the &lt;code&gt;DataSource&lt;/code&gt; to embed<a name="line.428"></a>
+<span class="sourceLineNo">429</span>     * @param name the name that will be set in the filename header field<a name="line.429"></a>
+<span class="sourceLineNo">430</span>     * @return the generated Content-ID for this &lt;code&gt;DataSource&lt;/code&gt;<a name="line.430"></a>
+<span class="sourceLineNo">431</span>     * @throws EmailException if the embedding fails or if &lt;code&gt;name&lt;/code&gt; is<a name="line.431"></a>
+<span class="sourceLineNo">432</span>     * null or empty<a name="line.432"></a>
+<span class="sourceLineNo">433</span>     * @see #embed(DataSource, String, String)<a name="line.433"></a>
+<span class="sourceLineNo">434</span>     * @since 1.1<a name="line.434"></a>
+<span class="sourceLineNo">435</span>     */<a name="line.435"></a>
+<span class="sourceLineNo">436</span>    public String embed(DataSource dataSource, String name) throws EmailException<a name="line.436"></a>
+<span class="sourceLineNo">437</span>    {<a name="line.437"></a>
+<span class="sourceLineNo">438</span>        // check if the DataSource has already been attached;<a name="line.438"></a>
+<span class="sourceLineNo">439</span>        // if so, return the cached CID value.<a name="line.439"></a>
+<span class="sourceLineNo">440</span>        if (inlineEmbeds.containsKey(name))<a name="line.440"></a>
+<span class="sourceLineNo">441</span>        {<a name="line.441"></a>
+<span class="sourceLineNo">442</span>            InlineImage ii = inlineEmbeds.get(name);<a name="line.442"></a>
+<span class="sourceLineNo">443</span>            // make sure the supplied URL points to the same thing<a name="line.443"></a>
+<span class="sourceLineNo">444</span>            // as the one already associated with this name.<a name="line.444"></a>
+<span class="sourceLineNo">445</span>            if (dataSource.equals(ii.getDataSource()))<a name="line.445"></a>
+<span class="sourceLineNo">446</span>            {<a name="line.446"></a>
+<span class="sourceLineNo">447</span>                return ii.getCid();<a name="line.447"></a>
+<span class="sourceLineNo">448</span>            }<a name="line.448"></a>
+<span class="sourceLineNo">449</span>            else<a name="line.449"></a>
+<span class="sourceLineNo">450</span>            {<a name="line.450"></a>
+<span class="sourceLineNo">451</span>                throw new EmailException("embedded DataSource '" + name<a name="line.451"></a>
+<span class="sourceLineNo">452</span>                    + "' is already bound to name " + ii.getDataSource().toString()<a name="line.452"></a>
+<span class="sourceLineNo">453</span>                    + "; existing names cannot be rebound");<a name="line.453"></a>
+<span class="sourceLineNo">454</span>            }<a name="line.454"></a>
+<span class="sourceLineNo">455</span>        }<a name="line.455"></a>
+<span class="sourceLineNo">456</span><a name="line.456"></a>
+<span class="sourceLineNo">457</span>        String cid = EmailUtils.randomAlphabetic(HtmlEmail.CID_LENGTH).toLowerCase();<a name="line.457"></a>
+<span class="sourceLineNo">458</span>        return embed(dataSource, name, cid);<a name="line.458"></a>
+<span class="sourceLineNo">459</span>    }<a name="line.459"></a>
+<span class="sourceLineNo">460</span><a name="line.460"></a>
+<span class="sourceLineNo">461</span>    /**<a name="line.461"></a>
+<span class="sourceLineNo">462</span>     * Embeds the specified &lt;code&gt;DataSource&lt;/code&gt; in the HTML using the<a name="line.462"></a>
+<span class="sourceLineNo">463</span>     * specified Content-ID. Returns the specified Content-ID string.<a name="line.463"></a>
+<span class="sourceLineNo">464</span>     *<a name="line.464"></a>
+<span class="sourceLineNo">465</span>     * @param dataSource the &lt;code&gt;DataSource&lt;/code&gt; to embed<a name="line.465"></a>
+<span class="sourceLineNo">466</span>     * @param name the name that will be set in the filename header field<a name="line.466"></a>
+<span class="sourceLineNo">467</span>     * @param cid the Content-ID to use for this &lt;code&gt;DataSource&lt;/code&gt;<a name="line.467"></a>
+<span class="sourceLineNo">468</span>     * @return the URL encoded Content-ID for this &lt;code&gt;DataSource&lt;/code&gt;<a name="line.468"></a>
+<span class="sourceLineNo">469</span>     * @throws EmailException if the embedding fails or if &lt;code&gt;name&lt;/code&gt; is<a name="line.469"></a>
+<span class="sourceLineNo">470</span>     * null or empty<a name="line.470"></a>
+<span class="sourceLineNo">471</span>     * @since 1.1<a name="line.471"></a>
+<span class="sourceLineNo">472</span>     */<a name="line.472"></a>
+<span class="sourceLineNo">473</span>    public String embed(DataSource dataSource, String name, String cid)<a name="line.473"></a>
+<span class="sourceLineNo">474</span>        throws EmailException<a name="line.474"></a>
+<span class="sourceLineNo">475</span>    {<a name="line.475"></a>
+<span class="sourceLineNo">476</span>        if (EmailUtils.isEmpty(name))<a name="line.476"></a>
+<span class="sourceLineNo">477</span>        {<a name="line.477"></a>
+<span class="sourceLineNo">478</span>            throw new EmailException("name cannot be null or empty");<a name="line.478"></a>
+<span class="sourceLineNo">479</span>        }<a name="line.479"></a>
+<span class="sourceLineNo">480</span><a name="line.480"></a>
+<span class="sourceLineNo">481</span>        MimeBodyPart mbp = new MimeBodyPart();<a name="line.481"></a>
+<span class="sourceLineNo">482</span><a name="line.482"></a>
+<span class="sourceLineNo">483</span>        try<a name="line.483"></a>
+<span class="sourceLineNo">484</span>        {<a name="line.484"></a>
+<span class="sourceLineNo">485</span>            // url encode the cid according to rfc 2392<a name="line.485"></a>
+<span class="sourceLineNo">486</span>            cid = EmailUtils.encodeUrl(cid);<a name="line.486"></a>
+<span class="sourceLineNo">487</span><a name="line.487"></a>
+<span class="sourceLineNo">488</span>            mbp.setDataHandler(new DataHandler(dataSource));<a name="line.488"></a>
+<span class="sourceLineNo">489</span>            mbp.setFileName(name);<a name="line.489"></a>
+<span class="sourceLineNo">490</span>            mbp.setDisposition(EmailAttachment.INLINE);<a name="line.490"></a>
+<span class="sourceLineNo">491</span>            mbp.setContentID("&lt;" + cid + "&gt;");<a name="line.491"></a>
+<span class="sourceLineNo">492</span><a name="line.492"></a>
+<span class="sourceLineNo">493</span>            InlineImage ii = new InlineImage(cid, dataSource, mbp);<a name="line.493"></a>
+<span class="sourceLineNo">494</span>            this.inlineEmbeds.put(name, ii);<a name="line.494"></a>
+<span class="sourceLineNo">495</span><a name="line.495"></a>
+<span class="sourceLineNo">496</span>            return cid;<a name="line.496"></a>
+<span class="sourceLineNo">497</span>        }<a name="line.497"></a>
+<span class="sourceLineNo">498</span>        catch (MessagingException me)<a name="line.498"></a>
+<span class="sourceLineNo">499</span>        {<a name="line.499"></a>
+<span class="sourceLineNo">500</span>            throw new EmailException(me);<a name="line.500"></a>
+<span class="sourceLineNo">501</span>        }<a name="line.501"></a>
+<span class="sourceLineNo">502</span>        catch (UnsupportedEncodingException uee)<a name="line.502"></a>
+<span class="sourceLineNo">503</span>        {<a name="line.503"></a>
+<span class="sourceLineNo">504</span>            throw new EmailException(uee);<a name="line.504"></a>
+<span class="sourceLineNo">505</span>        }<a name="line.505"></a>
+<span class="sourceLineNo">506</span>    }<a name="line.506"></a>
+<span class="sourceLineNo">507</span><a name="line.507"></a>
+<span class="sourceLineNo">508</span>    /**<a name="line.508"></a>
+<span class="sourceLineNo">509</span>     * Does the work of actually building the MimeMessage. Please note that<a name="line.509"></a>
+<span class="sourceLineNo">510</span>     * a user rarely calls this method directly and only if he/she is<a name="line.510"></a>
+<span class="sourceLineNo">511</span>     * interested in the sending the underlying MimeMessage without<a name="line.511"></a>
+<span class="sourceLineNo">512</span>     * commons-email.<a name="line.512"></a>
+<span class="sourceLineNo">513</span>     *<a name="line.513"></a>
+<span class="sourceLineNo">514</span>     * @exception EmailException if there was an error.<a name="line.514"></a>
+<span class="sourceLineNo">515</span>     * @since 1.0<a name="line.515"></a>
+<span class="sourceLineNo">516</span>     */<a name="line.516"></a>
+<span class="sourceLineNo">517</span>    @Override<a name="line.517"></a>
+<span class="sourceLineNo">518</span>    public void buildMimeMessage() throws EmailException<a name="line.518"></a>
+<span class="sourceLineNo">519</span>    {<a name="line.519"></a>
+<span class="sourceLineNo">520</span>        try<a name="line.520"></a>
+<span class="sourceLineNo">521</span>        {<a name="line.521"></a>
+<span class="sourceLineNo">522</span>            build();<a name="line.522"></a>
+<span class="sourceLineNo">523</span>        }<a name="line.523"></a>
+<span class="sourceLineNo">524</span>        catch (MessagingException me)<a name="line.524"></a>
+<span class="sourceLineNo">525</span>        {<a name="line.525"></a>
+<span class="sourceLineNo">526</span>            throw new EmailException(me);<a name="line.526"></a>
+<span class="sourceLineNo">527</span>        }<a name="line.527"></a>
+<span class="sourceLineNo">528</span>        super.buildMimeMessage();<a name="line.528"></a>
+<span class="sourceLineNo">529</span>    }<a name="line.529"></a>
+<span class="sourceLineNo">530</span><a name="line.530"></a>
+<span class="sourceLineNo">531</span>    /**<a name="line.531"></a>
+<span class="sourceLineNo">532</span>     * @throws EmailException EmailException<a name="line.532"></a>
+<span class="sourceLineNo">533</span>     * @throws MessagingException MessagingException<a name="line.533"></a>
+<span class="sourceLineNo">534</span>     */<a name="line.534"></a>
+<span class="sourceLineNo">535</span>    private void build() throws MessagingException, EmailException<a name="line.535"></a>
+<span class="sourceLineNo">536</span>    {<a name="line.536"></a>
+<span class="sourceLineNo">537</span>        MimeMultipart rootContainer = this.getContainer();<a name="line.537"></a>
+<span class="sourceLineNo">538</span>        MimeMultipart bodyEmbedsContainer = rootContainer;<a name="line.538"></a>
+<span class="sourceLineNo">539</span>        MimeMultipart bodyContainer = rootContainer;<a name="line.539"></a>
+<span class="sourceLineNo">540</span>        BodyPart msgHtml = null;<a name="line.540"></a>
+<span class="sourceLineNo">541</span>        BodyPart msgText = null;<a name="line.541"></a>
+<span class="sourceLineNo">542</span><a name="line.542"></a>
+<span class="sourceLineNo">543</span>        rootContainer.setSubType("mixed");<a name="line.543"></a>
+<span class="sourceLineNo">544</span><a name="line.544"></a>
+<span class="sourceLineNo">545</span>        // determine how to form multiparts of email<a name="line.545"></a>
+<span class="sourceLineNo">546</span><a name="line.546"></a>
+<span class="sourceLineNo">547</span>        if (EmailUtils.isNotEmpty(this.html) &amp;&amp; this.inlineEmbeds.size() &gt; 0)<a name="line.547"></a>
+<span class="sourceLineNo">548</span>        {<a name="line.548"></a>
+<span class="sourceLineNo">549</span>            //If HTML body and embeds are used, create a related container and add it to the root container<a name="line.549"></a>
+<span class="sourceLineNo">550</span>            bodyEmbedsContainer = new MimeMultipart("related");<a name="line.550"></a>
+<span class="sourceLineNo">551</span>            bodyContainer = bodyEmbedsContainer;<a name="line.551"></a>
+<span class="sourceLineNo">552</span>            this.addPart(bodyEmbedsContainer, 0);<a name="line.552"></a>
+<span class="sourceLineNo">553</span><a name="line.553"></a>
+<span class="sourceLineNo">554</span>            //If TEXT body was specified, create a alternative container and add it to the embeds container<a name="line.554"></a>
+<span class="sourceLineNo">555</span>            if (EmailUtils.isNotEmpty(this.text))<a name="line.555"></a>
+<span class="sourceLineNo">556</span>            {<a name="line.556"></a>
+<span class="sourceLineNo">557</span>                bodyContainer = new MimeMultipart("alternative");<a name="line.557"></a>
+<span class="sourceLineNo">558</span>                BodyPart bodyPart = createBodyPart();<a name="line.558"></a>
+<span class="sourceLineNo">559</span>                try<a name="line.559"></a>
+<span class="sourceLineNo">560</span>                {<a name="line.560"></a>
+<span class="sourceLineNo">561</span>                    bodyPart.setContent(bodyContainer);<a name="line.561"></a>
+<span class="sourceLineNo">562</span>                    bodyEmbedsContainer.addBodyPart(bodyPart, 0);<a name="line.562"></a>
+<span class="sourceLineNo">563</span>                }<a name="line.563"></a>
+<span class="sourceLineNo">564</span>                catch (MessagingException me)<a name="line.564"></a>
+<span class="sourceLineNo">565</span>                {<a name="line.565"></a>
+<span class="sourceLineNo">566</span>                    throw new EmailException(me);<a name="line.566"></a>
+<span class="sourceLineNo">567</span>                }<a name="line.567"></a>
+<span class="sourceLineNo">568</span>            }<a name="line.568"></a>
+<span class="sourceLineNo">569</span>        }<a name="line.569"></a>
+<span class="sourceLineNo">570</span>        else if (EmailUtils.isNotEmpty(this.text) &amp;&amp; EmailUtils.isNotEmpty(this.html))<a name="line.570"></a>
+<span class="sourceLineNo">571</span>        {<a name="line.571"></a>
+<span class="sourceLineNo">572</span>            //If both HTML and TEXT bodies are provided, create a alternative container and add it to the root container<a name="line.572"></a>
+<span class="sourceLineNo">573</span>            bodyContainer = new MimeMultipart("alternative");<a name="line.573"></a>
+<span class="sourceLineNo">574</span>            this.addPart(bodyContainer, 0);<a name="line.574"></a>
+<span class="sourceLineNo">575</span>        }<a name="line.575"></a>
+<span class="sourceLineNo">576</span><a name="line.576"></a>
+<span class="sourceLineNo">577</span>        if (EmailUtils.isNotEmpty(this.html))<a name="line.577"></a>
+<span class="sourceLineNo">578</span>        {<a name="line.578"></a>
+<span class="sourceLineNo">579</span>            msgHtml = new MimeBodyPart();<a name="line.579"></a>
+<span class="sourceLineNo">580</span>            bodyContainer.addBodyPart(msgHtml, 0);<a name="line.580"></a>
+<span class="sourceLineNo">581</span><a name="line.581"></a>
+<span class="sourceLineNo">582</span>            // apply default charset if one has been set<a name="line.582"></a>
+<span class="sourceLineNo">583</span>            if (EmailUtils.isNotEmpty(this.charset))<a name="line.583"></a>
+<span class="sourceLineNo">584</span>            {<a name="line.584"></a>
+<span class="sourceLineNo">585</span>                msgHtml.setContent(<a name="line.585"></a>
+<span class="sourceLineNo">586</span>                    this.html,<a name="line.586"></a>
+<span class="sourceLineNo">587</span>                    EmailConstants.TEXT_HTML + "; charset=" + this.charset);<a name="line.587"></a>
+<span class="sourceLineNo">588</span>            }<a name="line.588"></a>
+<span class="sourceLineNo">589</span>            else<a name="line.589"></a>
+<span class="sourceLineNo">590</span>            {<a name="line.590"></a>
+<span class="sourceLineNo">591</span>                msgHtml.setContent(this.html, EmailConstants.TEXT_HTML);<a name="line.591"></a>
+<span class="sourceLineNo">592</span>            }<a name="line.592"></a>
+<span class="sourceLineNo">593</span><a name="line.593"></a>
+<span class="sourceLineNo">594</span>            Iterator&lt;InlineImage&gt; iter = this.inlineEmbeds.values().iterator();<a name="line.594"></a>
+<span class="sourceLineNo">595</span>            while (iter.hasNext())<a name="line.595"></a>
+<span class="sourceLineNo">596</span>            {<a name="line.596"></a>
+<span class="sourceLineNo">597</span>                InlineImage ii = iter.next();<a name="line.597"></a>
+<span class="sourceLineNo">598</span>                bodyEmbedsContainer.addBodyPart(ii.getMbp());<a name="line.598"></a>
+<span class="sourceLineNo">599</span>            }<a name="line.599"></a>
+<span class="sourceLineNo">600</span>        }<a name="line.600"></a>
+<span class="sourceLineNo">601</span><a name="line.601"></a>
+<span class="sourceLineNo">602</span>        if (EmailUtils.isNotEmpty(this.text))<a name="line.602"></a>
+<span class="sourceLineNo">603</span>        {<a name="line.603"></a>
+<span class="sourceLineNo">604</span>            msgText = new MimeBodyPart();<a name="line.604"></a>
+<span class="sourceLineNo">605</span>            bodyContainer.addBodyPart(msgText, 0);<a name="line.605"></a>
+<span class="sourceLineNo">606</span><a name="line.606"></a>
+<span class="sourceLineNo">607</span>            // apply default charset if one has been set<a name="line.607"></a>
+<span class="sourceLineNo">608</span>            if (EmailUtils.isNotEmpty(this.charset))<a name="line.608"></a>
+<span class="sourceLineNo">609</span>            {<a name="line.609"></a>
+<span class="sourceLineNo">610</span>                msgText.setContent(<a name="line.610"></a>
+<span class="sourceLineNo">611</span>                    this.text,<a name="line.611"></a>
+<span class="sourceLineNo">612</span>                    EmailConstants.TEXT_PLAIN + "; charset=" + this.charset);<a name="line.612"></a>
+<span class="sourceLineNo">613</span>            }<a name="line.613"></a>
+<span class="sourceLineNo">614</span>            else<a name="line.614"></a>
+<span class="sourceLineNo">615</span>            {<a name="line.615"></a>
+<span class="sourceLineNo">616</span>                msgText.setContent(this.text, EmailConstants.TEXT_PLAIN);<a name="line.616"></a>
+<span class="sourceLineNo">617</span>            }<a name="line.617"></a>
+<span class="sourceLineNo">618</span>        }<a name="line.618"></a>
+<span class="sourceLineNo">619</span>    }<a name="line.619"></a>
+<span class="sourceLineNo">620</span><a name="line.620"></a>
+<span class="sourceLineNo">621</span>    /**<a name="line.621"></a>
+<span class="sourceLineNo">622</span>     * Private bean class that encapsulates data about URL contents<a name="line.622"></a>
+<span class="sourceLineNo">623</span>     * that are embedded in the final email.<a name="line.623"></a>
+<span class="sourceLineNo">624</span>     * @since 1.1<a name="line.624"></a>
+<span class="sourceLineNo">625</span>     */<a name="line.625"></a>
+<span class="sourceLineNo">626</span>    private static class InlineImage<a name="line.626"></a>
+<span class="sourceLineNo">627</span>    {<a name="line.627"></a>
+<span class="sourceLineNo">628</span>        /** content id. */<a name="line.628"></a>
+<span class="sourceLineNo">629</span>        private String cid;<a name="line.629"></a>
+<span class="sourceLineNo">630</span>        /** &lt;code&gt;DataSource&lt;/code&gt; for the content. */<a name="line.630"></a>
+<span class="sourceLineNo">631</span>        private DataSource dataSource;<a name="line.631"></a>
+<span class="sourceLineNo">632</span>        /** the &lt;code&gt;MimeBodyPart&lt;/code&gt; that contains the encoded data. */<a name="line.632"></a>
+<span class="sourceLineNo">633</span>        private MimeBodyPart mbp;<a name="line.633"></a>
+<span class="sourceLineNo">634</span><a name="line.634"></a>
+<span class="sourceLineNo">635</span>        /**<a name="line.635"></a>
+<span class="sourceLineNo">636</span>         * Creates an InlineImage object to represent the<a name="line.636"></a>
+<span class="sourceLineNo">637</span>         * specified content ID and &lt;code&gt;MimeBodyPart&lt;/code&gt;.<a name="line.637"></a>
+<span class="sourceLineNo">638</span>         * @param cid the generated content ID<a name="line.638"></a>
+<span class="sourceLineNo">639</span>         * @param dataSource the &lt;code&gt;DataSource&lt;/code&gt; that represents the content<a name="line.639"></a>
+<span class="sourceLineNo">640</span>         * @param mbp the &lt;code&gt;MimeBodyPart&lt;/code&gt; that contains the encoded<a name="line.640"></a>
+<span class="sourceLineNo">641</span>         * data<a name="line.641"></a>
+<span class="sourceLineNo">642</span>         */<a name="line.642"></a>
+<span class="sourceLineNo">643</span>        public InlineImage(String cid, DataSource dataSource, MimeBodyPart mbp)<a name="line.643"></a>
+<span class="sourceLineNo">644</span>        {<a name="line.644"></a>
+<span class="sourceLineNo">645</span>            this.cid = cid;<a name="line.645"></a>
+<span class="sourceLineNo">646</span>            this.dataSource = dataSource;<a name="line.646"></a>
+<span class="sourceLineNo">647</span>            this.mbp = mbp;<a name="line.647"></a>
+<span class="sourceLineNo">648</span>        }<a name="line.648"></a>
+<span class="sourceLineNo">649</span><a name="line.649"></a>
+<span class="sourceLineNo">650</span>        /**<a name="line.650"></a>
+<span class="sourceLineNo">651</span>         * Returns the unique content ID of this InlineImage.<a name="line.651"></a>
+<span class="sourceLineNo">652</span>         * @return the unique content ID of this InlineImage<a name="line.652"></a>
+<span class="sourceLineNo">653</span>         */<a name="line.653"></a>
+<span class="sourceLineNo">654</span>        public String getCid()<a name="line.654"></a>
+<span class="sourceLineNo">655</span>        {<a name="line.655"></a>
+<span class="sourceLineNo">656</span>            return cid;<a name="line.656"></a>
+<span class="sourceLineNo">657</span>        }<a name="line.657"></a>
+<span class="sourceLineNo">658</span><a name="line.658"></a>
+<span class="sourceLineNo">659</span>        /**<a name="line.659"></a>
+<span class="sourceLineNo">660</span>         * Returns the &lt;code&gt;DataSource&lt;/code&gt; that represents the encoded content.<a name="line.660"></a>
+<span class="sourceLineNo">661</span>         * @return the &lt;code&gt;DataSource&lt;/code&gt; representing the encoded content<a name="line.661"></a>
+<span class="sourceLineNo">662</span>         */<a name="line.662"></a>
+<span class="sourceLineNo">663</span>        public DataSource getDataSource()<a name="line.663"></a>
+<span class="sourceLineNo">664</span>        {<a name="line.664"></a>
+<span class="sourceLineNo">665</span>            return dataSource;<a name="line.665"></a>
+<span class="sourceLineNo">666</span>        }<a name="line.666"></a>
+<span class="sourceLineNo">667</span><a name="line.667"></a>
+<span class="sourceLineNo">668</span>        /**<a name="line.668"></a>
+<span class="sourceLineNo">669</span>         * Returns the &lt;code&gt;MimeBodyPart&lt;/code&gt; that contains the<a name="line.669"></a>
+<span class="sourceLineNo">670</span>         * encoded InlineImage data.<a name="line.670"></a>
+<span class="sourceLineNo">671</span>         * @return the &lt;code&gt;MimeBodyPart&lt;/code&gt; containing the encoded<a name="line.671"></a>
+<span class="sourceLineNo">672</span>         * InlineImage data<a name="line.672"></a>
+<span class="sourceLineNo">673</span>         */<a name="line.673"></a>
+<span class="sourceLineNo">674</span>        public MimeBodyPart getMbp()<a name="line.674"></a>
+<span class="sourceLineNo">675</span>        {<a name="line.675"></a>
+<span class="sourceLineNo">676</span>            return mbp;<a name="line.676"></a>
+<span class="sourceLineNo">677</span>        }<a name="line.677"></a>
+<span class="sourceLineNo">678</span><a name="line.678"></a>
+<span class="sourceLineNo">679</span>        // equals()/hashCode() implementations, since this class<a name="line.679"></a>
+<span class="sourceLineNo">680</span>        // is stored as a entry in a Map.<a name="line.680"></a>
+<span class="sourceLineNo">681</span>        /**<a name="line.681"></a>
+<span class="sourceLineNo">682</span>         * {@inheritDoc}<a name="line.682"></a>
+<span class="sourceLineNo">683</span>         * @return true if the other object is also an InlineImage with the same cid.<a name="line.683"></a>
+<span class="sourceLineNo">684</span>         */<a name="line.684"></a>
+<span class="sourceLineNo">685</span>        @Override<a name="line.685"></a>
+<span class="sourceLineNo">686</span>        public boolean equals(Object obj)<a name="line.686"></a>
+<span class="sourceLineNo">687</span>        {<a name="line.687"></a>
+<span class="sourceLineNo">688</span>            if (this == obj)<a name="line.688"></a>
+<span class="sourceLineNo">689</span>            {<a name="line.689"></a>
+<span class="sourceLineNo">690</span>                return true;<a name="line.690"></a>
+<span class="sourceLineNo">691</span>            }<a name="line.691"></a>
+<span class="sourceLineNo">692</span>            if (!(obj instanceof InlineImage))<a name="line.692"></a>
+<span class="sourceLineNo">693</span>            {<a name="line.693"></a>
+<span class="sourceLineNo">694</span>                return false;<a name="line.694"></a>
+<span class="sourceLineNo">695</span>            }<a name="line.695"></a>
+<span class="sourceLineNo">696</span><a name="line.696"></a>
+<span class="sourceLineNo">697</span>            InlineImage that = (InlineImage) obj;<a name="line.697"></a>
+<span class="sourceLineNo">698</span><a name="line.698"></a>
+<span class="sourceLineNo">699</span>            return this.cid.equals(that.cid);<a name="line.699"></a>
+<span class="sourceLineNo">700</span>        }<a name="line.700"></a>
+<span class="sourceLineNo">701</span><a name="line.701"></a>
+<span class="sourceLineNo">702</span>        /**<a name="line.702"></a>
+<span class="sourceLineNo">703</span>         * {@inheritDoc}<a name="line.703"></a>
+<span class="sourceLineNo">704</span>         * @return the cid hashCode.<a name="line.704"></a>
+<span class="sourceLineNo">705</span>         */<a name="line.705"></a>
+<span class="sourceLineNo">706</span>        @Override<a name="line.706"></a>
+<span class="sourceLineNo">707</span>        public int hashCode()<a name="line.707"></a>
+<span class="sourceLineNo">708</span>        {<a name="line.708"></a>
+<span class="sourceLineNo">709</span>            return cid.hashCode();<a name="line.709"></a>
+<span class="sourceLineNo">710</span>        }<a name="line.710"></a>
+<span class="sourceLineNo">711</span>    }<a name="line.711"></a>
+<span class="sourceLineNo">712</span>}<a name="line.712"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>

Propchange: websites/production/commons/content/proper/commons-email/javadocs/api-release/src-html/org/apache/commons/mail/HtmlEmail.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: websites/production/commons/content/proper/commons-email/javadocs/api-release/src-html/org/apache/commons/mail/HtmlEmail.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision HeadURL

Propchange: websites/production/commons/content/proper/commons-email/javadocs/api-release/src-html/org/apache/commons/mail/HtmlEmail.html
------------------------------------------------------------------------------
    svn:mime-type = text/html



Mime
View raw message