|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.util.velocity.VelocityEmail
This is a simple class for sending email from within Velocity. Essentially, the body of the email is processed with a Velocity Context object. 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!
Example Usage (This all needs to be on one line in your template):
Setup your context:
context.put ("VelocityEmail", new VelocityEmail() );
Then, in your template:
$VelocityEmail.setTo("Jon Stevens", "jon@latchkey.com") .setFrom("Mom", "mom@mom.com").setSubject("Eat dinner") .setTemplate("email/momEmail.vm") .setContext($context)The email/momEmail.wm template will then be parsed with the Context that was defined with setContext().
If you want to use this class from within your Java code all you have to do is something like this:
VelocityEmail ve = new VelocityEmail(); ve.setTo("Jon Stevens", "jon@latchkey.com"); ve.setFrom("Mom", "mom@mom.com").setSubject("Eat dinner"); ve.setContext(context); ve.setTemplate("email/momEmail.vm") ve.send();
(Note that when used within a Velocity template, the send method will be called for you when Velocity tries to convert the VelocityEmail to a string by calling toString()).
If you need your email to be word-wrapped, you can add the following call to those above:
ve.setWordWrap (60);
This class is just a wrapper around the SimpleEmail class. 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 TurbineConfig class for more information.
Constructor Summary | |
VelocityEmail()
Constructor |
|
VelocityEmail(org.apache.velocity.context.Context context)
Constructor |
Method Summary | |
org.apache.velocity.context.Context |
getContext()
Get the context object that will be merged with the template. |
void |
send()
This method sends the email. |
VelocityEmail |
setContext(org.apache.velocity.context.Context context)
Set the context object that will be merged with the template. |
VelocityEmail |
setFrom(java.lang.String from,
java.lang.String email)
From: name, email. |
VelocityEmail |
setSubject(java.lang.String subject)
Subject. |
VelocityEmail |
setTemplate(java.lang.String template)
Velocity template to execute. |
VelocityEmail |
setTo(java.lang.String to,
java.lang.String email)
To: name, email |
VelocityEmail |
setWordWrap(int wordWrap)
Set the column at which long lines of text should be word- wrapped. |
java.lang.String |
toString()
The method toString() calls send() for ease of use within a Velocity template (see example usage above). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public VelocityEmail()
public VelocityEmail(org.apache.velocity.context.Context context)
Method Detail |
public VelocityEmail setTo(java.lang.String to, java.lang.String email)
to
- A String with the TO name.email
- A String with the TO email.public VelocityEmail setFrom(java.lang.String from, java.lang.String email)
from
- A String with the FROM name.email
- A String with the FROM email.public VelocityEmail setSubject(java.lang.String subject)
subject
- A String with the subject.public VelocityEmail setTemplate(java.lang.String template)
template
- A String with the template.public VelocityEmail setWordWrap(int wordWrap)
wordWrap
- The column at which to wrap long lines.public VelocityEmail setContext(org.apache.velocity.context.Context context)
context
- A Velocity context object.public org.apache.velocity.context.Context getContext()
public void send() throws java.lang.Exception
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |