mx4j.tools.mail
Interface SMTPMBean

All Known Implementing Classes:

SMTP

public interface SMTPMBean

Management Interface of a SMTP MBean.

This MBean is meant to send a mail given certain situation. It may be used to listen to a monitor or timer and send a mail.

To use it you need to add to your classpath the mail.jar from the JavaMail API and the activation.jar from the Java Activation Framework.

Besides you need to configure all the required fields, at least the serverHost and To fields and if your server requires login also the serverUsername and serverPassword fields

The subject and content fields are subject to keyword expansions, i.e. some keyworks put between $ signs will be exapnded this can be used to give a more informative message. The current available expansions are

$date$ -> Current date formatted with locale format $time$ -> Current tim formatted with locale format $datetime$ -> Current date and time formatted with locale format $notification$ -> Notification type $observed$ -> ObjectName of the observed object $objectname$ -> This MBean's objectname

Version:

$Revision: 1.4 $

Method Summary

java.lang.String	getBCC() Gets a comma separated list of addresses set in the BCC field
java.lang.String	getCC() Gets a comma separated list of addresses set in the CC field
java.lang.String	getContent() Returns the content of the mail
java.lang.String	getFromAddress() Gets the from address attached to mails
java.lang.String	getFromName() Gets the from name presented on the mail
java.lang.String	getMimeType() Gets the MIME type set to the mail
java.lang.String	getNotificationName() Returns the notification which will trigger the mail sending
javax.management.ObjectName	getObservedObject() Gets the MBean's objectname which is being listened
java.lang.String	getServerHost() Gets the server's host as name or IP
int	getServerPort() Gets the server's port, by default is 25
java.lang.String	getServerUsername() Gets the username to log to the server
java.lang.String	getSubject() Gets the mail subject
int	getTimeout() Returns the timeout used when sending mails
java.lang.String	getTo() Gets a comma separated list of addresses set in the TO field
boolean	isLoginToServer() Indicates whether login to the SMTP server will be attpemted
void	sendMail() This will directly execute the send mail.
void	setBCC(java.lang.String bccAddresses) Sets a comma separated list of address which will go in the BCC mail field
void	setCC(java.lang.String ccAddresses) Sets a comma separated list of address which will go in the CC mail field
void	setContent(java.lang.String content) Sets the content of the mail
void	setFromAddress(java.lang.String fromAddress) Sets the form address set to mail
void	setFromName(java.lang.String fromName) Sets the from name presented on the mail
void	setLoginToServer(boolean login) Sets whether to login to the SMTP server
void	setMimeType(java.lang.String mimeType) Sets the MIME type, by default it is text/plain
void	setNotificationName(java.lang.String notificationName) Sets the notification name which will trigger the mail sending.
void	setObservedObject(javax.management.ObjectName targetMBeanName) Sets the observed object.
void	setServerHost(java.lang.String host) Sets the server's host, it can be set as name or IP
void	setServerPassword(java.lang.String password) Sets server's passowrd, use with setLoginToServer(true) and setServerUsername
void	setServerPort(int port) Sets the server's port.
void	setServerUsername(java.lang.String username) Sets server's username, use with setLoginToServer(true)
void	setSubject(java.lang.String subject) Sets the mail's subject, by default is Empty subject.
void	setTimeout(int timeout) Sets the send timeout, by default it is 10 secs
void	setTo(java.lang.String toAddresses) Sets a comma separated list of address which will go in the TO mail field

Method Detail

getObservedObject

public javax.management.ObjectName getObservedObject()

Gets the MBean's objectname which is being listened

setObservedObject

public void setObservedObject(javax.management.ObjectName targetMBeanName)

Sets the observed object. It is expected that the observed MBean is a NotificationBroadcster On the contrary the MBean will not be listening to events

getNotificationName

public java.lang.String getNotificationName()

Returns the notification which will trigger the mail sending

setNotificationName

public void setNotificationName(java.lang.String notificationName)

Sets the notification name which will trigger the mail sending. If it is null any notification will trigger a mail

getServerHost

public java.lang.String getServerHost()

Gets the server's host as name or IP

setServerHost

public void setServerHost(java.lang.String host)

Sets the server's host, it can be set as name or IP

setServerPort

public void setServerPort(int port)

Sets the server's port.

getServerPort

public int getServerPort()

Gets the server's port, by default is 25

setServerUsername

public void setServerUsername(java.lang.String username)

Sets server's username, use with setLoginToServer(true)

getServerUsername

public java.lang.String getServerUsername()

Gets the username to log to the server

setServerPassword

public void setServerPassword(java.lang.String password)

Sets server's passowrd, use with setLoginToServer(true) and setServerUsername

setLoginToServer

public void setLoginToServer(boolean login)

Sets whether to login to the SMTP server

isLoginToServer

public boolean isLoginToServer()

Indicates whether login to the SMTP server will be attpemted

setTimeout

public void setTimeout(int timeout)

Sets the send timeout, by default it is 10 secs

getTimeout

public int getTimeout()

Returns the timeout used when sending mails

getFromAddress

public java.lang.String getFromAddress()

Gets the from address attached to mails

setFromAddress

public void setFromAddress(java.lang.String fromAddress)

Sets the form address set to mail

getFromName

public java.lang.String getFromName()

Gets the from name presented on the mail

setFromName

public void setFromName(java.lang.String fromName)

Sets the from name presented on the mail

getMimeType

public java.lang.String getMimeType()

Gets the MIME type set to the mail

setMimeType

public void setMimeType(java.lang.String mimeType)

Sets the MIME type, by default it is text/plain

getTo

public java.lang.String getTo()

Gets a comma separated list of addresses set in the TO field

setTo

public void setTo(java.lang.String toAddresses)

Sets a comma separated list of address which will go in the TO mail field

getBCC

public java.lang.String getBCC()

Gets a comma separated list of addresses set in the BCC field

setBCC

public void setBCC(java.lang.String bccAddresses)

Sets a comma separated list of address which will go in the BCC mail field

getCC

public java.lang.String getCC()

Gets a comma separated list of addresses set in the CC field

setCC

public void setCC(java.lang.String ccAddresses)

Sets a comma separated list of address which will go in the CC mail field

getSubject

public java.lang.String getSubject()

Gets the mail subject

setSubject

public void setSubject(java.lang.String subject)

Sets the mail's subject, by default is Empty subject. The subject field can contain keyword expansion

getContent

public java.lang.String getContent()

Returns the content of the mail

setContent

public void setContent(java.lang.String content)

Sets the content of the mail

sendMail

public void sendMail()

This will directly execute the send mail. It can be used to manually testing the MBean or direct execution