info.soaj.mail.plugin
Class SjPluginTextEmail

java.lang.Object
  info.soaj.core.plugin.SjBasePlugin
      info.soaj.core.plugin.SjAbstractPluginEmail
          info.soaj.mail.plugin.SjPluginTextEmail

All Implemented Interfaces:

java.io.Serializable

public class SjPluginTextEmail
extends SjAbstractPluginEmail

This SOAj plugin supports emailing of messages containing text.

Copyright (c) 2006 - 2009 by Global Technology Consulting Group, Inc. at gtcGroup.com .

Since:

v. 1.0

Author:

MarvinToll@gtcGroup.com

See Also:

Serialized Form

Field Summary

private static java.lang.String	CLASS_NAME Class name.
private static long	serialVersionUID UID

Constructor Summary

SjPluginTextEmail(SjPopulatedPluginKey pluginKey)
Constructor - protected

Method Summary

SjBaseMetadata	createPluginMetadataCB() This method
boolean	sendEmail(SjAttributesForAbstractPluginEmail emailAttributes) This method sends an email message using JavaMail.
boolean	sendEmailThrowable(SjAttributesForAbstractPluginEmail emailAttributes) This method sends an email exception message using JavaMail.

Methods inherited from class info.soaj.core.plugin.SjAbstractPluginEmail

getMaximumExceptionMessagesPerDay, getMaximumExceptionMessagesPerHour, verifyCB

Methods inherited from class info.soaj.core.plugin.SjBasePlugin

getPluginMetadata, getPluginProperties, getPopulatedPluginKey, initCB

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID

See Also:

Constant Field Values

CLASS_NAME

private static final java.lang.String CLASS_NAME

Class name.

Constructor Detail

SjPluginTextEmail

public SjPluginTextEmail(SjPopulatedPluginKey pluginKey)

Constructor - protected

The SOAj plugin pattern enforces instantiation of a plugin via the General Store. Concrete class constructors should be coded as 'protected'.

Parameters:

pluginKey - The 'Key' defined in the descriptor document.

Method Detail

createPluginMetadataCB

public SjBaseMetadata createPluginMetadataCB()

Description copied from class: SjBasePlugin

This method

Specified by:

createPluginMetadataCB in class SjBasePlugin

Returns:

SjBaseMetadata - The wrapper object containing plugin information.

See Also:

SjBasePlugin.createPluginMetadataCB()

sendEmail

public boolean sendEmail(SjAttributesForAbstractPluginEmail emailAttributes)

This method sends an email message using JavaMail.

Specified by:

sendEmail in class SjAbstractPluginEmail

Parameters:

emailAttributes - Includes the message text.

Returns:

boolean - 'True' indicates the message was successfully sent.

sendEmailThrowable

public boolean sendEmailThrowable(SjAttributesForAbstractPluginEmail emailAttributes)

This method sends an email exception message using JavaMail.

Specified by:

sendEmailThrowable in class SjAbstractPluginEmail

Parameters:

emailAttributes - Includes the message text.

Returns:

boolean - 'True' indicates the message was successfully sent.