<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Mailer MBean</title><link href="styles.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL Stylesheets V1.78.1" name="generator"><link rel="home" href="index.html" title="MX4J English Documentation"><link rel="up" href="ch06.html" title="Chapter 6. MX4J Tools"><link rel="prev" href="ch06s03.html" title="Naming MBeans"><link rel="next" href="ch06s05.html" title="Jython MBean"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Mailer MBean</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ch06s03.html">Prev</a> </td><th align="center" width="60%">Chapter 6. MX4J Tools</th><td align="right" width="20%"> <a accesskey="n" href="ch06s05.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N10D64"></a>Mailer MBean</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="N10D67"></a>Introduction</h3></div></div></div><p>
The SMTP MBean is meant to be used to send emails from your JMX application.
The MBean's class is
<code class="classname">mx4j.tools.mail.SMTP</code>.
</p><p>
You can use it in basically two ways:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
Directly by calling the sendMail method
</p></li><li class="listitem"><p>
By listening notifications, for instance from a Timer or Monitor
</p></li></ul></div><p>
</p><p>
The usage of the MBean requires that you have JavaMail and the Java Activation Framework.
The MBean has been tested with JavaMail 1.2 and JAF 1.0.1.
</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="N10D7B"></a>Configuration</h3></div></div></div><p>
The MBean has quite many attributes to work but as a minimum you should set up the
<span class="emphasis"><em>serverHost</em></span>
and
<span class="emphasis"><em>To</em></span>. After that you can start sending emails.
</p><p>
If your server requires authentication, set the
<span class="emphasis"><em>LoginToServer</em></span> attribute to true
and fill the
<span class="emphasis"><em>ServerUserName</em></span> and
<span class="emphasis"><em>ServerPassword fields</em></span>
</p><p>
You can also set the source address by setting the
<span class="emphasis"><em>FromAddress</em></span> field as well
as the
<span class="emphasis"><em>FromName</em></span> field. The destination attributes can be set setting a comma separated
list of addresses by using the
<span class="emphasis"><em>To</em></span>,
<span class="emphasis"><em>Cc</em></span> and
<span class="emphasis"><em>Bcc</em></span> attributes.
The addresses are not checked until a mail is actually sent, but in case some are not well formed, to those who are will be sent anyway
</p><p>
To make the MBean to listen for notifications set the
<span class="emphasis"><em>ObservedObject</em></span> field. The SMTPMBean
will register iteself as listener of that MBean and when a notification is received it will send the mail.
If you set the
<span class="emphasis"><em>NotificationName</em></span> field, only notification names with that type will be
valid to send a mail. For instance "javax.management.monitor.string.differ"
</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="N10DAA"></a>Keyword expanding</h3></div></div></div><p>
To make the content of the mail more customizable you can include keyword expansion
on the
<span class="emphasis"><em>Subject</em></span>, and
<span class="emphasis"><em>Content</em></span> field. The keywords
are special words set in between of $ signs. e.g. $date$. Those keywords will be replaced
before the mail is sent, so you can get text containing more information.
The recognized keywords are:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="emphasis"><em>$date$</em></span> Expands to the current date formatted with locale format
</p></li><li class="listitem"><p>
<span class="emphasis"><em>$time$</em></span> Expands to the current time formatted with locale format
</p></li><li class="listitem"><p>
<span class="emphasis"><em>$datetime$</em></span> Expands to the current datetime formatted with locale format
</p></li><li class="listitem"><p>
<span class="emphasis"><em>$observed$</em></span> Expands to the observed MBean's ObjectName which triggered the mail
</p></li><li class="listitem"><p>
<span class="emphasis"><em>$notification$</em></span> Expands to the notification type which triggered the mail
</p></li><li class="listitem"><p>
<span class="emphasis"><em>$objectname$</em></span> Expands to the SMTPMBean's ObjectName
</p></li></ul></div><p>
</p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ch06s03.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="ch06.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ch06s05.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Naming MBeans </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Jython MBean</td></tr></table></div></body></html>
