Page History

This is an analysis of the work needed to enable CSF-based apps to send authenticated email.

h2. Changes to CSF:

h4. 1. Configuration of mailSender Spring Bean

Configure mailSender bean to use additional properties. Currently only uses "host" = "outgoing.mit.edu". This would be a modification to applicationContext-csf-email-scheduler.xml in the csf-email module. The additional properties are:

{code

}
<bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
  <property name="host" value="outgoing.mit.edu"/>
  <property name="port" value="587"/>
  <property name="username" value="USERNAME"/>
  <property name="password" value="PASSWORD"/>
  <property name="javaMailProperties">
    <props>
      <prop key="mail.debug">false</prop>
      <prop key="mail.smtp.auth">true</prop>
      <prop key="mail.smtp.starttls.enable">true</prop>
    </props>
  </property>
</bean>
{code}

The _username_, _password_, _port_, and possibly _host_, property values should be externalized to a properties file. We can put these properties in machine.properties - apps should pick this up automatically. Only one copy of this props file per server.

Any app that needs to use this feature would have to upgrade its version of CSF and be retested. Each app would also need to reviewed to make sure it uses "machine.properties" in its property configuration.

h4.

 2.One Login Per Batch of Email Messages

One question - for a bulk email send, should we authenticate to the server for every single email message in the batch:

{code

}
DO FOR EACH MAIL MESSAGE
    authenticate to server    send email message
END DO
{code}
or just once for the batch:

{code

}
authenticate to serverDO FOR EACH MAIL MESSAGE
    send email message
END DO
{code}
My initial test with CSF does the former. WTW seems to do the latter.

The latter seems better (only one login per batch rather than one login per message). To do this, the email service needs to change - in fact it may be better to change it anyway. In "batchSend", instead of:

{code

}
Get list of email events
DO FOR each email event
  create MimeMessagePreparator
  send message using MimeMessagePreparator
  update email event
END DO
{code}
do this:

{code

}
Get list of email events
DO FOR each email event
  create MimeMessagePreparator and store in list
END DO

send messages using list of MimeMessagePreparators
update email events
{code}
We would use the "batch" API of Spring's JavaMailSender API:

{code

}
send(MimeMessagePreparator[] mimeMessagePreparators)
{code}
instead of

{code

}
send(MimeMessagePreparator mimeMessagePreparator)

{code}

h2. Summary

This change would mean:
# Modifications to csf-email (detailed above)

# Changes to common property files (i.e. machine.properties) on each server that hosts CSF web apps.

# Build & release of each web app that needs to use this feature.

# Retest of each rebuilt app.