mx4j.tools.mail

Interface SMTPMBean

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

$Revision: 1.4 $

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

getBCC

public String getBCC()

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

getCC

public String getCC()

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

getContent

public String getContent()

Returns the content of the mail

getFromAddress

public String getFromAddress()

Gets the from address attached to mails

getFromName

public String getFromName()

Gets the from name presented on the mail

getMimeType

public String getMimeType()

Gets the MIME type set to the mail

getNotificationName

public String getNotificationName()

Returns the notification which will trigger the mail sending

getObservedObject

public javax.management.ObjectName getObservedObject()

Gets the MBean's objectname which is being listened

getServerHost

public String getServerHost()

Gets the server's host as name or IP

getServerPort

public int getServerPort()

Gets the server's port, by default is 25

getServerUsername

public String getServerUsername()

Gets the username to log to the server

getSubject

public String getSubject()

Gets the mail subject

getTimeout

public int getTimeout()

Returns the timeout used when sending mails

getTo

public String getTo()

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

isLoginToServer

public boolean isLoginToServer()

Indicates whether login to the SMTP server will be attpemted

sendMail

public void sendMail()

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

setBCC

public void setBCC(String bccAddresses)

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

setCC

public void setCC(String ccAddresses)

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

setContent

public void setContent(String content)

Sets the content of the mail

setFromAddress

public void setFromAddress(String fromAddress)

Sets the form address set to mail

setFromName

public void setFromName(String fromName)

Sets the from name presented on the mail

setLoginToServer

public void setLoginToServer(boolean login)

Sets whether to login to the SMTP server

setMimeType

public void setMimeType(String mimeType)

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

setNotificationName

public void setNotificationName(String notificationName)

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

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

setServerHost

public void setServerHost(String host)

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

setServerPassword

public void setServerPassword(String password)

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

setServerPort

public void setServerPort(int port)

Sets the server's port.

setServerUsername

public void setServerUsername(String username)

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

setSubject

public void setSubject(String subject)

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

setTimeout

public void setTimeout(int timeout)

Sets the send timeout, by default it is 10 secs

setTo

public void setTo(String toAddresses)

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

Overview Package Class Use Tree Index Deprecated About
Prev Class \| Next Class	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr