Package org.opennms.javamail

Class JavaSendMailer

java.lang.Object

org.opennms.javamail.JavaMailer2

org.opennms.javamail.JavaSendMailer

public class JavaSendMailer
extends JavaMailer2

Use this class for sending e-mails.

Crude extension of JavaMailer

TODO: Improve class hierarchy

TODO: Needs testing

Author:

David Hustace

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.javamail.JavaMailer2

JavaMailer2.LoggingByteArrayOutputStream, JavaMailer2.LoggingTransportListener

Constructor Summary

Constructors

Constructor	Description
JavaSendMailer(SendmailConfig config)	Instantiates a new java send mailer.
JavaSendMailer(SendmailConfig config, boolean useJmProps)	Instantiates a new java send mailer.

Method Summary

Modifier and Type	Method	Description
javax.mail.internet.MimeMessage	buildMimeMessage(SendmailMessage msg)	Builds the mime message.
javax.mail.Authenticator	createAuthenticator()	Creates the authenticator.
SendmailConfig	getConfig()	Gets the sendmail configuration.
javax.mail.internet.MimeMessage	getMessage()	Gets the message.
java.util.Properties	getProperties()	Gets the properties.
void	send()	Send.
void	send(javax.mail.internet.MimeMessage message)	Send.
void	setConfig(SendmailConfig config)	Sets the sendmail configuration.
void	setMessage(javax.mail.internet.MimeMessage message)	Sets the message.
void	setProperties(java.util.Properties properties)	Sets the properties.

Methods inherited from class org.opennms.javamail.JavaMailer2

createAuthenticator, createFileAttachment, getMailProps, getSession, setDebug, setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaSendMailer

public JavaSendMailer(SendmailConfig config,
                      boolean useJmProps)
               throws JavaMailerException

Instantiates a new java send mailer.

Constructs everything required to call send().

Parameters:

config - the sendmail configuration

useJmProps - a boolean representing the handling of the deprecated javamail-configuration.properties file.

Throws:

JavaMailerException - the java mailer exception

JavaSendMailer

public JavaSendMailer(SendmailConfig config)
               throws JavaMailerException

Instantiates a new java send mailer.

Using this constructor implies overriding sendmail configuration with properties from the deprecated javamail-configuration.properties file.

Parameters:

config - the sendmail configuration

Throws:

JavaMailerException - the java mailer exception

Method Detail

buildMimeMessage

public javax.mail.internet.MimeMessage buildMimeMessage(SendmailMessage msg)

Builds the mime message.

Parameters:

msg - the sendmail message

Returns:

the mime message

createAuthenticator

public javax.mail.Authenticator createAuthenticator()

Creates the authenticator.

Returns:

the authenticator

send

public void send()
          throws JavaMailerException

Send.

Throws:

JavaMailerException - the java mailer exception

send

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

Send.

Parameters:

message - the message

Throws:

JavaMailerException - the java mailer exception

setConfig

public void setConfig(SendmailConfig config)

Sets the sendmail configuration.

Parameters:

config - the new sendmail configuration

getConfig

public SendmailConfig getConfig()

Gets the sendmail configuration.

Returns:

the sendmail configuration

setMessage

public void setMessage(javax.mail.internet.MimeMessage message)

Sets the message.

Parameters:

message - the new message

getMessage

public javax.mail.internet.MimeMessage getMessage()

Gets the message.

Returns:

the message

setProperties

public void setProperties(java.util.Properties properties)

Sets the properties.

Parameters:

properties - the new properties

getProperties

public java.util.Properties getProperties()

Gets the properties.

Returns:

the properties