← Zurück zum Blog

Java: E-Mails mit Spring versenden

Übersetzter Artikel. Original lesen

Java: E-Mails mit Spring versenden

Dieser Beitrag zeigt, wie mit Spring und der Klasse MailSender eine kleine Mail-Hilfsklasse erstellt wird. Zunächst folgt die Konfiguration für die XML-Datei des Application Context.

Spring-Mail-Bean im Application Context konfigurieren

<!-- Spring Mail Sender config -->
<bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
    <property name="host" value="smtp-server.com" />
    <property name="port" value="587" />
    <property name="username" value="username" />
    <property name="password" value="password" />

    <property name="javaMailProperties">
       <props>
       	      <prop key="mail.smtp.auth">true</prop>
       	      <prop key="mail.smtp.starttls.enable">true</prop>
       	   </props>
    </property>
</bean>

<!-- Here we initialize a utility which will use our bean.
    This way it is possible to autowire/inject the mailer everywhere
    it is needed.
-->
<bean id="mailUtility" class="me.kamwo.mail.utility.MailUtility" />

Hier geschehen zwei Dinge. Zuerst wird eine Bean namens mailSender vom Typ org.springframework.mail.javamail.JavaMailSenderImpl definiert. Diese Klasse implementiert die JavaMail-API. Die Eigenschaften konfigurieren Zielserver, Port und Authentifizierung beim SMTP-Server des E-Mail-Anbieters.

Der letzte Abschnitt definiert eine weitere Bean namens mailUtility.

<bean id="mailUtility" class="me.kamwo.mail.utility.MailUtility" />

Sie initialisiert die Klasse MailUtility, die als Wrapper um die zuvor definierte mailSender-Bean dient. Als Bean lässt sie sich einfach in jede benötigte Klasse injizieren.

MailUtility: Wrapper um den Spring MailSender

Der folgende einfache Wrapper versendet reine Textnachrichten und kann je nach Anwendungsfall erweitert werden ;-)

/*
 * MailUtility.java
 *
 */
package me.kamwo.mail.utility;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.mail.MailSender;
import org.springframework.mail.SimpleMailMessage;

/**
 *
 * @author kwozniak
 */
public class MailUtility {

    @Autowired
    private MailSender mailSender;

    private String fromAddress = "admin@example.com";

    private String toAddress = "someoneElse@example.com";

    private String subject = "Default mailer subject";

    private String message = "Hi, your order is ready :-)";

    /**
     * Sends an email.
     *
     * @param from Senders email address
     * @param to Receivers email address
     * @param subject Subject of the email
     * @param msg msg of the email.
     */
    public void sendMail(String from, String to, String subject, String msg) {

        SimpleMailMessage mailMessage = new SimpleMailMessage();

        mailMessage.setFrom(from);
        mailMessage.setTo(to);
        mailMessage.setSubject(subject);
        mailMessage.setText(msg);
        mailSender.send(mailMessage);
    }

    /**
     * Sends an email. The senders address will be the default one.
     *
     * @param to Receivers email address
     * @param subject Subject of the email
     * @param msg msg of the email.
     */
    public void sendMail(String to, String subject, String msg) {
        sendMail(fromAddress, to, subject, msg);
    }

    /**
     * Sends an email. The senders and recipient address will be the default ones.
     *
     * @param subject Subject of the email
     * @param msg msg of the email.
     */
    public void sendMail(String subject, String msg) {
        sendMail(fromAddress, toAddress, subject, msg);
    }

    /**
     * Sends an email. The senders and recipient address and also the default subject,
     * will be the default one.
     *
     * @param msg msg of the email.
     */
    public void sendMail(String msg) {
        sendMail(fromAddress, toAddress, subject, msg);
    }
}

MailUtility injizieren

Die Mail-Hilfsklasse kann überall dort injiziert werden, wo sie benötigt wird:

@Inject
private MailUtility mailUtility;