org.wandora.modules

Class EmailModule

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.EmailModule

All Implemented Interfaces:

Module

public class EmailModule
extends AbstractModule

A module that provides email sending services for other modules. Requires details of the SMTP server in the module parameters passed to the init method. These are given in parameters smtpServer, smtpPort smtpUseTLS, smtpUseSSLAuth, smtpUser and smtpPass. In addition to these a default from field and default subject can be specified in parameters defaultFrom and defaultSubject. These will be used if other modules don't specify anything else for those fields.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	charsetPattern
protected java.lang.String	defaultCharset
protected java.lang.String	defaultContentType
protected java.lang.String	defaultFrom
protected java.lang.String	defaultSubject
protected java.util.Properties	mailProps
protected java.lang.String	smtpPass
protected int	smtpPort
protected java.lang.String	smtpServer
protected boolean	smtpSSLAuth
protected boolean	smtpTLS
protected java.lang.String	smtpUser

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
EmailModule()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
boolean	send(java.util.List<java.lang.String> recipients, java.lang.String from, java.lang.String subject, java.util.List<javax.mail.BodyPart> parts)
boolean	send(java.util.List<java.lang.String> recipients, java.lang.String from, java.lang.String subject, javax.mail.internet.MimeMultipart content)
boolean	send(java.util.List<java.lang.String> recipients, java.lang.String from, java.lang.String subject, java.lang.Object message, java.lang.String mimeType)
boolean	send(java.lang.String recipient, java.lang.String from, java.lang.String subject, java.lang.Object message)
boolean	send(java.lang.String recipient, java.lang.String from, java.lang.String subject, java.lang.Object message, java.lang.String mimeType)

Methods inherited from class org.wandora.modules.AbstractModule

isInitialized, isRunning, requireLogging, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

smtpServer

protected java.lang.String smtpServer

smtpPort

protected int smtpPort

smtpUser

protected java.lang.String smtpUser

smtpPass

protected java.lang.String smtpPass

smtpTLS

protected boolean smtpTLS

smtpSSLAuth

protected boolean smtpSSLAuth

defaultFrom

protected java.lang.String defaultFrom

defaultSubject

protected java.lang.String defaultSubject

defaultCharset

protected java.lang.String defaultCharset

defaultContentType

protected java.lang.String defaultContentType

mailProps

protected java.util.Properties mailProps

charsetPattern

protected static java.util.regex.Pattern charsetPattern

Constructor Detail

EmailModule

public EmailModule()

Method Detail

send

public boolean send(java.util.List<java.lang.String> recipients,
                    java.lang.String from,
                    java.lang.String subject,
                    javax.mail.internet.MimeMultipart content)

send

public boolean send(java.util.List<java.lang.String> recipients,
                    java.lang.String from,
                    java.lang.String subject,
                    java.util.List<javax.mail.BodyPart> parts)

send

public boolean send(java.util.List<java.lang.String> recipients,
                    java.lang.String from,
                    java.lang.String subject,
                    java.lang.Object message,
                    java.lang.String mimeType)

send

public boolean send(java.lang.String recipient,
                    java.lang.String from,
                    java.lang.String subject,
                    java.lang.Object message,
                    java.lang.String mimeType)

send

public boolean send(java.lang.String recipient,
                    java.lang.String from,
                    java.lang.String subject,
                    java.lang.Object message)

getDependencies

public java.util.Collection<Module> getDependencies(ModuleManager manager)
                                             throws ModuleException

Description copied from interface: Module

Returns all the modules this module depends on. This method will be called after init and the dependencies are allowed to depend on the parameters passed to init. The modules that this module depends on must be returned as a collection. In addition, if any required module is not present, a MissingDependencyException should be thrown. Typically you will use the requireModule and optionalModule methods of the manager to make sure that the modules exist and add them to the collection. requireModule will automatically throw the exception too if the module is not found whereas optionalModule does not.

Specified by:

getDependencies in interface Module

Overrides:

getDependencies in class AbstractModule

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class AbstractModule

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException