Java Doc for SendMailTransformer.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » mail » transformation » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The SendMailTransformer requires the Sun's JavaMail API implementation. Please download and copy the following files to the Cocoon lib directory:

• mail.jar from http://java.sun.com/products/javamail/
• activation.jar from http://java.sun.com/products/javabeans/glasgow/jaf.html

Use the following sitemap component declaration to define, configure and parameterize the transformer. in the map:sitemap/map:components/map:transformers:

 <map:transformer name="sendmail" src="org.apache.cocoon.mail.transformation.SendMailTransformer">
 <smtphost>smtp.foo.com</smtphost>
 <from>sender@localhost</from>
 </map:transformer>
 

where
• <smtphost> is the SMTP server host name, e.g. smtp.foo.com
• <from> is the sender e-mail address

Furthermore, these parameters can be defined in the sitemap pipeline section:

• smtphost, from - If they are defined, this values overwrite the values from component section described above.
• to - email addresses of recipients e.g.: <map:parameter name="to" value="customer1@target.com,customer2@target.com"/>
• subject - a string, can also come from an input module e.g.; <map:parameter name="subject" value="{request-param:subject}"/>
• body - a string, can also come from an input module e.g.; <map:parameter name="body" value="{request-param:body}"/>
• sendpartial - a boolean, define how to send the mails. When mail is being send to more than one recipient and the parameter is set to false, then all email addresses will appear concatenated in the address field at the mail client of the recipient. The default is true.

More configurations can be made in a specific configuration file, which can be retrieved with a generator as the input document. The input document should have the following configuration entities:

• <email:smtphost>, <email:from> and <email:subject> can be set to overwrite values from the sitemap
• <email:to> - each entry will be append to the list of email addresses
• <email:body> - Overwrites the value from the sitemap. If there is a src attribute, the transformer will try to retrieve the file and place it instead of a text-string as the mail body.
• <email:attachment> - each entry defines a attachment. The attribute name defines the name of the attachment. The mime-type attribute defines the content of the attachment. If there is a nested <email:content> - element, text can be included and the attachment will then be a plain text-file. Is there a url attribute, the transformer tries to retrieve the appropriate file and handle it as an attachment. To use a file as an attachment, retrieved over a protocol like http or cocoon, use the src attribute.

Input document sample:

 <?xml version="1.0" encoding="UTF-8"?>
 <document xmlns:email="http://apache.org/cocoon/transformation/sendmail">
 <email:sendmail>
 <email:smtphost>hostname.company.com</email:smtphost>
 <email:from>info@company.com</email:from>
 <email:to>customer3@target.com</email:to>
 <email:to>customer4@target.com</email:to>
 <email:to>customer5@target.com</email:to>
 <email:to>customer6@target.com</email:to>
 <email:subject>subject-content</email:subject>
 <email:body src="cocoon:/softwareupdate.html?locale=en&country=UK"/>
 <!-- <email:body>some Text</email:body> -->
 <email:attachment name="hello.html" mime-type="text/html">
 <email:content>
 Dear Customer, please visit out new Product-Shop.
 </email:content>
 </email:attachment>
 <email:attachment name="hello2.html" mime-type="text/html" src="cocoon:/src1"/>
 <email:attachment name="hello3.html" mime-type="text/html"
 url="C:\path\softwareupdate.html"/>
 <email:attachment name="hello.gif" mime-type="image/gif"
 url="c:\path\powered.gif"/>
 </email:sendmail>
 </document>
 

After the transformation a report will be generated, where the state for each sent mail can be seen. In case of an exception, the exception-message and a stacktrace will be reported.

FIXME: Known Issues:

• Refactor to use MailSender component
• No support for RFC 2554: SMTP Service Extension for Authentication
• No support for different mail servers, first one will always be used

author:
   Peter Klassen
version:
   $Id: SendMailTransformer.java 525980 2007-04-05 22:18:04Z hepabolu $