Java Doc for VelocityHtmlEmail.java in » Web-Framework » TURBINE » org » apache » turbine » util » velocity » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.util.velocity

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.turbine.util.velocity .VelocityHtmlEmail

VelocityHtmlEmail

public class VelocityHtmlEmail extends HtmlEmail (Code)

This is a simple class for sending html email from within Velocity. Essentially, the bodies (text and html) of the email are a Velocity Context objects. The beauty of this is that you can send email from within your Velocity template or from your business logic in your Java code. The body of the email is just a Velocity template so you can use all the template functionality of Velocity within your emails!

This class allows you to send HTML email with embedded content and/or with attachments. You can access the VelocityHtmlEmail instance within your templates trough the $mail Velocity variable.

VelocityHtmlEmail myEmail= new VelocityHtmlEmail(data); context.put("mail", myMail); or VelocityHtmlEmail myEmail= new VelocityHtmlEmail(context); context.put("mail", myMail);

The templates should be located under your Template turbine directory.

This class wraps the HtmlEmail class from commons-email. Thus, it uses the JavaMail API and also depends on having the mail.server property set in the TurbineResources.properties file. If you want to use this class outside of Turbine for general processing that is also possible by making sure to set the path to the TurbineResources.properties. See the TurbineResourceService.setPropertiesFileName() method for more information.

This class is basically a conversion of the WebMacroHtmlEmail written by Regis Koenig

You can turn on debugging for the JavaMail API by calling setDebug(true). The debugging messages will be written to System.out.
author:
   Eric Pugh
author:
   Andre Schild
author:
   Quinton McCombs
author:
   Henning P. Schmiedehausen
version:
   $Id: VelocityHtmlEmail.java 534527 2007-05-02 16:10:59Z tv $

Constructor Summary
public	VelocityHtmlEmail(RunData data)
public	VelocityHtmlEmail(Context context) Constructor, sets the context object.

Method Summary
public String	embed(String surl, String name) Embed a file in the mail.
public String	getCid(String filename) Get the cid of an embedded file. Parameters: filename - A String.
public String	getMailServer() Gets the host name of the outgoing mail server.
public String	send() Actually send the mail.
public VelocityHtmlEmail	setHtmlTemplate(String template) Set the HTML template for the mail.
public void	setMailServer(String serverAddress) Sets the address of the outgoing mail server.
public VelocityHtmlEmail	setTextTemplate(String template) Set the text template for the mail.

Constructor Detail

VelocityHtmlEmail
public VelocityHtmlEmail(RunData data)(Code)
	Constructor, sets the context object from the passed RunData object Parameters: data - A Turbine RunData object.

VelocityHtmlEmail
public VelocityHtmlEmail(Context context)(Code)
	Constructor, sets the context object. Parameters: context - A Velocity context object.

Method Detail

embed

public String embed(String surl, String name) throws VelocityEmailException(Code)

Embed a file in the mail. The file can be referenced through its Content-ID. This function also registers the CID in an internal map, so the embedded file can be referenced more than once by using the getCid() function. This may be useful in a template.

Example of template:

 <html>
 <!-- $mail.embed("http://server/border.gif","border.gif"); -->
 <img src=$mail.getCid("border.gif")>
 <p>This is your content
 <img src=$mail.getCid("border.gif")>
 </html>

Parameters:
  surl - A String.
Parameters:
  name - A String. A String with the cid of the embedded file.
exception:
  VelocityEmailException -
See Also:   HtmlEmail.embed(URL surlString name)
See Also:    embed.

getCid
public String getCid(String filename)(Code)
	Get the cid of an embedded file. Parameters: filename - A String. A String with the cid of the embedded file. See Also: VelocityHtmlEmail.embed(String surl,String name) See Also: embed.

getMailServer
public String getMailServer()(Code)
	Gets the host name of the outgoing mail server. If the server name has not been set by calling setMailServer(), the value from TR.props for mail.server will be returned. If TR.props has no value for mail.server, localhost will be returned. host name of the mail server.

send
public String send() throws EmailException(Code)
	Actually send the mail. exception: EmailException - thrown if mail cannot be sent.

setHtmlTemplate
public VelocityHtmlEmail setHtmlTemplate(String template)(Code)
	Set the HTML template for the mail. This is the Velocity template to execute for the HTML part. Path is relative to the VM templates directory. Parameters: template - A String. A VelocityHtmlEmail (self).

setMailServer
public void setMailServer(String serverAddress)(Code)
	Sets the address of the outgoing mail server. This method should be used when you need to override the value stored in TR.props. Parameters: serverAddress - host name of your outgoing mail server

setTextTemplate
public VelocityHtmlEmail setTextTemplate(String template)(Code)
	Set the text template for the mail. This is the Velocity template to execute for the text part. Path is relative to the VM templates directory Parameters: template - A String. A VelocityHtmlEmail (self).

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.