Spring Framework

org.springframework.mail.javamail
Interface MimeMessagePreparator


public interface MimeMessagePreparator

Callback interface for the preparation of JavaMail MIME messages.

The corresponding send methods of JavaMailSender will take care of the actual creation of a MimeMessage instance, and of proper exception conversion.

It is often convenient to use a MimeMessageHelper for populating the passed-in MimeMessage, in particular when working with attachments or special character encodings. See MimeMessageHelper's javadoc for an example.

Since:
07.10.2003
Author:
Juergen Hoeller
See Also:
JavaMailSender.send(MimeMessagePreparator), JavaMailSender.send(MimeMessagePreparator[]), MimeMessageHelper

Method Summary
 void prepare(javax.mail.internet.MimeMessage mimeMessage)
          Prepare the given new MimeMessage instance.
 

Method Detail

prepare

void prepare(javax.mail.internet.MimeMessage mimeMessage)
             throws java.lang.Exception
Prepare the given new MimeMessage instance.

Parameters:
mimeMessage - the message to prepare
Throws:
javax.mail.MessagingException - passing any exceptions thrown by MimeMessage methods through for automatic conversion to the MailException hierarchy
java.io.IOException - passing any exceptions thrown by MimeMessage methods through for automatic conversion to the MailException hierarchy
java.lang.Exception - if mail preparation failed, for example when a Velocity template cannot be rendered for the mail text

Spring Framework