com.premiumminds.webapp.utils.mailer

Class AbstractMailer

java.lang.Object

com.premiumminds.webapp.utils.mailer.AbstractMailer

Direct Known Subclasses:

SimpleMailer

public abstract class AbstractMailer
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractMailer.Configuration Generic mailer configurations

Constructor Summary

Constructors

Constructor and Description
AbstractMailer()

Method Summary

Modifier and Type	Method and Description
static void	configure(InputStream input) Loads mailer properties from a given configuration file input stream
static void	configure(Properties properties)
protected static Collection<javax.mail.internet.InternetAddress>	convertStringsToAddressess(Collection<String> mails) Converts a list of strings to a list of corresponding internet addresses
protected static javax.mail.internet.InternetAddress	convertStringToAddress(String mail) Converts a given string representation of an email address to an internet address
protected static Properties	getConfiguration() Gets the Properties object with the mailer configurations.
protected static String	getConfigurationProperty(String key) Gets the configuration property for the given key
protected static String	getConfigurationProperty(String key, String defaultValue) Gets the configuration property for the given key
String	getDebugAddress() Returns the debug mode email address.
static List<String>	getList(String value) Helper function to get a list from a configuration property value
boolean	isDebug() Returns whether or not the mailer is in debug mode
protected static boolean	isValidBasicConfiguration(Properties config) Checks if any essential configurations are incorrect
protected boolean	isValidConfiguration(Properties config) Checks if the mailer configurations are all correct
static boolean	isValidEmail(String email) Helper function to aid in the validation of email addresses.
protected abstract boolean	isValidMailerConfiguration(Properties config) Checks if any implementation specific mailer configurations are incorrect
abstract void	send(Collection<String> to, Collection<String> ccs, Collection<String> bccs, Map<String,String> headers, String subject, String body) Sends an email
abstract void	send(Collection<String> to, Collection<String> ccs, Collection<String> bccs, String subject, String body) Sends an email
abstract void	send(javax.mail.internet.MimeMessage message) Sends an email
abstract void	send(String to, Map<String,String> headers, String subject, String body) Sends an email
abstract void	send(String to, String subject, String body) Sends an email

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMailer

public AbstractMailer()

Method Detail

getConfigurationProperty

protected static String getConfigurationProperty(String key)

Gets the configuration property for the given key

Parameters:

key - The configuration property key

Returns:

The configuration property value

getConfigurationProperty

protected static String getConfigurationProperty(String key,
                                                 String defaultValue)

Gets the configuration property for the given key

Parameters:

key - The configuration property key

defaultValue - The default value to be returned if the actual value is null

Returns:

The configuration property value

getConfiguration

protected static Properties getConfiguration()

Gets the Properties object with the mailer configurations.

Returns:

The mailer properties.

configure

public static final void configure(InputStream input)
                            throws IOException

Loads mailer properties from a given configuration file input stream

Parameters:

input - The properties file input stream

Throws:

IOException - some error occurs reading from input

configure

public static final void configure(Properties properties)
                            throws IOException

Throws:

IOException

isDebug

public final boolean isDebug()

Returns whether or not the mailer is in debug mode

Returns:

true if is in debug mode

getDebugAddress

public final String getDebugAddress()

Returns the debug mode email address. All emails will be sent to this address when in debug mode.

Returns:

A string with the debug email address

convertStringToAddress

protected static javax.mail.internet.InternetAddress convertStringToAddress(String mail)
                                                                     throws MailerException

Converts a given string representation of an email address to an internet address

Parameters:

mail - The string email address

Returns:

The internet address for the email address given in the input

Throws:

MailerException - address is not valid

convertStringsToAddressess

protected static Collection<javax.mail.internet.InternetAddress> convertStringsToAddressess(Collection<String> mails)
                                                                                     throws MailerException

Converts a list of strings to a list of corresponding internet addresses

Parameters:

mails - The list of string addresses

Returns:

A list of internet addresses

Throws:

MailerException - some address is not valid

getList

public static List<String> getList(String value)

Helper function to get a list from a configuration property value

Parameters:

value - the property value

Returns:

a list of String property values

isValidConfiguration

protected final boolean isValidConfiguration(Properties config)

Checks if the mailer configurations are all correct

Parameters:

config - The configuration properties

Returns:

true if OK

isValidBasicConfiguration

protected static final boolean isValidBasicConfiguration(Properties config)

Checks if any essential configurations are incorrect

Parameters:

config - The configuration properties

Returns:

true if OK

isValidEmail

public static final boolean isValidEmail(String email)

Helper function to aid in the validation of email addresses.

Parameters:

email - The email address to be validated.

Returns:

true if the email address is valid.

isValidMailerConfiguration

protected abstract boolean isValidMailerConfiguration(Properties config)

Checks if any implementation specific mailer configurations are incorrect

Parameters:

config - the configuration properties

Returns:

true if OK

send

public abstract void send(javax.mail.internet.MimeMessage message)
                   throws MailerException

Sends an email

Parameters:

message - The Mime message object to be sent

Throws:

MailerException - some problem with the arguments

send

public abstract void send(String to,
                          String subject,
                          String body)
                   throws MailerException

Sends an email

Parameters:

to - The destination email

subject - the message subject

body - The message body

Throws:

MailerException - some problem with the arguments

send

public abstract void send(String to,
                          Map<String,String> headers,
                          String subject,
                          String body)
                   throws MailerException

Sends an email

Parameters:

to - The destination email

headers - A map with any header values to be added or overridden

subject - the message subject

body - The message body

Throws:

MailerException - some problem with the arguments

send

public abstract void send(Collection<String> to,
                          Collection<String> ccs,
                          Collection<String> bccs,
                          String subject,
                          String body)
                   throws MailerException

Sends an email

Parameters:

to - The destination email

ccs - Carbon copy addresses

bccs - Carbon copy addresses

subject - the message subject

body - The message body

Throws:

MailerException - some problem with the arguments

send

public abstract void send(Collection<String> to,
                          Collection<String> ccs,
                          Collection<String> bccs,
                          Map<String,String> headers,
                          String subject,
                          String body)
                   throws MailerException

Sends an email

Parameters:

to - The destination email

ccs - Carbon copy addresses

bccs - Carbon copy addresses

headers - A map with any header values to be added or overridden

subject - the message subject

body - The message body

Throws:

MailerException - some problem with the arguments