Mail Server Configuration for Release 3.2

Quick Links
Mail Server Configuration

Documentation Home

Mail Server Configuration

The ScrumWorks Pro server can be configured to send e-mail notifications to users based on certain events. The notification feature in the ScrumWorks Pro client will be disabled if a mail server is not configured. To enable this functionality, the ScrumWorks Pro administrator must make some modifications to the server configuration.
Supported Configurations
ScrumWorks Pro will work with plain, unauthenticated SMTP.

SMTP over SSL and Authenticated SMTP are not supported.


» top

SMTP Server Address
ScrumWorks Pro requires a connection to an SMTP server than can send mail to users. To configure the location of the server:
  1. Shut down your ScrumWorks Pro server

  2. Edit the file <install_directory>/server/scrumworks/deploy/mail-service.xml

  3. Change the value of the property "mail.smtp.host" from "smtp.nosuchhost.nosuchdomain.com" to the name of your mail server. An example is:
    <property name="mail.smtp.host" value="mail.example.com"/>

  4. If necessary, change the value of the property "mail.smtp.port" from "25" to the port your server runs on. An example is:
    <property name="mail.smtp.port" value="25"/>

  5. Change the value of the property "mail.from" to the address the emails should come from. An example is:
    <property name="mail.from" value="scrumworks@example.com">

  6. There are other options in the file, but most of them should not change. In particular, "mail.transport.protocol" should be left as "smtp":
    <property name="mail.transport.protocol" value="smtp">

  7. Save the file

  8. Start your ScrumWorks Pro server


» top

Example Configuration
<?xml version="1.0" encoding="UTF-8"?>
<server>

  <mbean code="org.jboss.mail.MailService"
         name="jboss:service=Mail">
    <attribute name="JNDIName">java:/Mail</attribute>
    <attribute name="User">nobody</attribute>
    <attribute name="Password">password</attribute>
    <attribute name="Configuration">
      <!-- A test configuration -->
      <configuration>
        <!-- Change to your mail server prototocol -->
        <property name="mail.store.protocol" value="pop3"/>
        <property name="mail.transport.protocol" value="smtp"/>

        <!-- Change to the user who will receive mail  -->
        <property name="mail.user" value="nobody"/>

        <!-- Change to the mail server  -->
        <property name="mail.pop3.host" value="pop3.nosuchhost.nosuchdomain.com"/>

        <!-- Change to the SMTP gateway server -->
        <property name="mail.smtp.host" value="mail.example.com"/>
        
        <!-- The mail server port -->
        <property name="mail.smtp.port" value="25"/>
        
        <!-- Change to the address mail will be from  -->
        <property name="mail.from" value="scrumworks@example.com"/>

        <!-- Enable debugging output from the javamail classes -->
        <property name="mail.debug" value="false"/>
      </configuration>
    </attribute>
    <depends>jboss:service=Naming</depends>
  </mbean>

</server>
            


» top