org.imixs.workflow.engine.plugins

Class MailPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.MailPlugin

All Implemented Interfaces:

Plugin

public class MailPlugin
extends AbstractPlugin

This plug-in supports a Mail interface to send a email to a list of recipients. The mail content can be defined by the corresponding BPMN event. The content of the email can either be plain text or HTML. The plug-in uses a JNID messaging session named 'org.imixs.workflow.mail'. The JNDI resource can be customized by the deployment constructor. The e-mail message can be canceled by the application or another plug-in by setting the attribute keyMailInactive=true

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_ADDRESS
static String	INVALID_XSL_FORMAT

Fields inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor and Description
MailPlugin()

Method Summary

Modifier and Type	Method and Description
void	close(boolean rollbackTransaction) Send the mail if the object 'mailMessage' is not null.
String	getBody(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail body from the current workflow event.
String	getCharSet()
String	getContentType() This method returns a string representing the mail content type.
String	getFrom(ItemCollection documentContext, ItemCollection documentActivity) Computes the sender name.
javax.mail.internet.InternetAddress	getInternetAddress(String aAddr) This method creates an InternetAddress from a string.
javax.mail.Message	getMailMessage()
javax.mail.Session	getMailSession() This method returns the mail session object.
javax.mail.Multipart	getMultipart()
List<String>	getRecipients(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail Recipients from the current workflow activity.
List<String>	getRecipientsBCC(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail RecipientsBCC from the current workflow activity.
List<String>	getRecipientsCC(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail RecipientsCC from the current workflow activity.
String	getReplyTo(ItemCollection documentContext, ItemCollection documentActivity) Computes the replyTo address from current workflow activity.
String	getSubject(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail subject from the current workflow activity.
void	initMailMessage() initializes a new mail Message object
void	initMailSession() This method initializes a new instance of a MailSession.
boolean	isHTMLMail() Return true if the mail body contains HTML content.
ItemCollection	run(ItemCollection documentContext, ItemCollection documentActivity) The run method creates a mailMessage object if recipients are defined by the corresponding BPMN event.
void	setCharSet(String charSet)
String	transformXSLBody(ItemCollection documentContext, String xslTemplate) This method performs a XSL transformation based on the current Mail Body text.

Methods inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

getCtx, getWorkflowService, init, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_XSL_FORMAT

public static final String INVALID_XSL_FORMAT

See Also:

Constant Field Values

INVALID_ADDRESS

public static final String INVALID_ADDRESS

See Also:

Constant Field Values

Constructor Detail

MailPlugin

public MailPlugin()

Method Detail

run

public ItemCollection run(ItemCollection documentContext,
                          ItemCollection documentActivity)
                   throws PluginException

The run method creates a mailMessage object if recipients are defined by the corresponding BPMN event. The mail message will finally be send in the close method. This mechanism avoids that a mail is send before all plug-ins were processed correctly.

Throws:

PluginException

close

public void close(boolean rollbackTransaction)
           throws PluginException

Send the mail if the object 'mailMessage' is not null. The method lookups the mail session from the session context.

Specified by:

close in interface Plugin

Overrides:

close in class AbstractPlugin

Throws:

PluginException

getFrom

public String getFrom(ItemCollection documentContext,
                      ItemCollection documentActivity)

Computes the sender name. This method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String - mail subject

getReplyTo

public String getReplyTo(ItemCollection documentContext,
                         ItemCollection documentActivity)

Computes the replyTo address from current workflow activity. This method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String - replyTo address

getSubject

public String getSubject(ItemCollection documentContext,
                         ItemCollection documentActivity)
                  throws PluginException

Computes the mail subject from the current workflow activity. This method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String - mail subject

Throws:

PluginException

getRecipients

public List<String> getRecipients(ItemCollection documentContext,
                                  ItemCollection documentActivity)

Computes the mail Recipients from the current workflow activity. This method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String list of Recipients

getRecipientsCC

public List<String> getRecipientsCC(ItemCollection documentContext,
                                    ItemCollection documentActivity)

Computes the mail RecipientsCC from the current workflow activity. This method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String list of Recipients

getRecipientsBCC

public List<String> getRecipientsBCC(ItemCollection documentContext,
                                     ItemCollection documentActivity)

Computes the mail RecipientsBCC from the current workflow activity. This method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String list of Recipients

getBody

public String getBody(ItemCollection documentContext,
                      ItemCollection documentActivity)
               throws PluginException

Computes the mail body from the current workflow event. The method also updates the internal flag HTMLMail to indicate if the mail is send as HTML mail. In case the content contains a XSL Template, the template will be processed with the current document structure. The method can be overwritten by subclasses.

Parameters:

documentContext -

documentActivity -

Returns:

String - mail subject

Throws:

PluginException

transformXSLBody

public String transformXSLBody(ItemCollection documentContext,
                               String xslTemplate)
                        throws PluginException

This method performs a XSL transformation based on the current Mail Body text. The xml source is generated form the current document context. encoding is set to UTF-8

Returns:

translated email body

Throws:

PluginException

initMailMessage

public void initMailMessage()
                     throws javax.mail.internet.AddressException,
                            javax.mail.MessagingException

initializes a new mail Message object

Throws:

javax.mail.internet.AddressException

javax.mail.MessagingException

getInternetAddress

public javax.mail.internet.InternetAddress getInternetAddress(String aAddr)
                                                       throws javax.mail.internet.AddressException

This method creates an InternetAddress from a string. If the string has illegal characters like whitespace the string will be surrounded with "". The method can be overwritten by subclasses to return a different mail-address name or lookup a mail attribute in a directory.

Parameters:

aAddr - string

Returns:

InternetAddress

Throws:

javax.mail.internet.AddressException

initMailSession

public void initMailSession()

This method initializes a new instance of a MailSession. The MailSession is received from the current jndi context. The Default name of the Mail Session is 'org.imixs.workflow.jee.mailsession' The name can be overwritten by the EJB Properties of the workflowmanager

getMailSession

public javax.mail.Session getMailSession()

This method returns the mail session object. If no mailSession exists the method initializes a new instance of a MailSession.

getMailMessage

public javax.mail.Message getMailMessage()

getMultipart

public javax.mail.Multipart getMultipart()

isHTMLMail

public boolean isHTMLMail()

Return true if the mail body contains HTML content.

Returns:

getCharSet

public String getCharSet()

setCharSet

public void setCharSet(String charSet)

getContentType

public String getContentType()

This method returns a string representing the mail content type. The content type depends on the content of the mail body (html or plaintext) and contains optional the character set. If the mail is a HTML mail then the returned string contains 'text/html' otherwise it will contain 'text/plain'. The content

Returns: