org.opennms.javamail
Class JavaMailer2

java.lang.Object
  org.opennms.javamail.JavaMailer2

Direct Known Subclasses:

JavaReadMailer, JavaSendMailer

public abstract class JavaMailer2
extends Object

Sends an email message using the Java Mail API

Version:

$Id: $

Author:

David Hustace

Nested Class Summary

static class	JavaMailer2.LoggingByteArrayOutputStream
static class	JavaMailer2.LoggingTransportListener

Constructor Summary

JavaMailer2()
Default constructor.

JavaMailer2(Properties javamailProps)
Constructor for JavaMailer2.

Method Summary

javax.mail.Authenticator	createAuthenticator(String user, String password) Helper method to create an Authenticator based on Password Authentication
javax.mail.internet.MimeBodyPart	createFileAttachment(File file) Create a file attachment as a MimeBodyPart, checking to see if the file exists before we create the attachment.
Properties	getMailProps() This returns the properties configured in the javamail-configuration.properties file.
javax.mail.Session	getSession() getSession
protected static ThreadCategory	log() log
void	setDebug(boolean debug) setDebug
void	setSession(javax.mail.Session session) setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaMailer2

public JavaMailer2(Properties javamailProps)
            throws JavaMailerException

Constructor for JavaMailer2.

Parameters:

javamailProps - a Properties object.

Throws:

JavaMailerException - if any.

JavaMailer2

public JavaMailer2()
            throws JavaMailerException

Default constructor. Default properties from javamailer-properties are set into session. To change these properties, retrieve the current properties from the session and override as needed.

Throws:

IOException - if any.

JavaMailerException - if any.

Method Detail

createAuthenticator

public javax.mail.Authenticator createAuthenticator(String user,
                                                    String password)

Helper method to create an Authenticator based on Password Authentication

Parameters:

user - a String object.

password - a String object.

Returns:

a Authenticator object.

createFileAttachment

public javax.mail.internet.MimeBodyPart createFileAttachment(File file)
                                                      throws javax.mail.MessagingException,
                                                             JavaMailerException

Create a file attachment as a MimeBodyPart, checking to see if the file exists before we create the attachment.

Parameters:

file - file to attach

Returns:

attachment body part

Throws:

javax.mail.MessagingException - if we can't set the data handler or the file name on the MimeBodyPart

JavaMailerException - if the file does not exist or is not readable

setDebug

public void setDebug(boolean debug)

setDebug

Parameters:

debug - a boolean.

log

protected static ThreadCategory log()

log

Returns:

log4j Category

getSession

public javax.mail.Session getSession()

getSession

Returns:

the session

setSession

public void setSession(javax.mail.Session session)

setSession

Parameters:

session - the session to set

getMailProps

public Properties getMailProps()

This returns the properties configured in the javamail-configuration.properties file.

Returns:

a Properties object.