SpringBoot配置Email发送功能

本文详细介绍如何在SpringBoot项目中配置并使用Email服务,包括QQ邮箱和QQ企业邮箱的配置步骤及常见异常分析。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

SpringBoot配置Email发送功能


本篇介绍在SpringBoot中配置Email服务的具体步骤,以及常见的异常分析。
具体案例以QQ邮箱以及QQ企业邮箱为例。

  • QQ邮箱发送方式
  • QQ企业邮箱发送方式
  • 总结

tips:
下面提到的hashIndex指的是一个元素put到hashmap中时,要根据其key.hashcode & (table.size()-1)来决定其在table中的位置。

table是一个数组,类型为Node。Node是hashmap的一个内部类,用来描述hashmap的元素的一些属性。


1.相关依赖包

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.0.RELEASE</version>
</parent>

 <dependencies>
        <!-- springBoot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>1.3.0.RELEASE</version>
        </dependency>
        <!-- email -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        <!-- html模板 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-velocity</artifactId>
        </dependency>
</dependencies>

SpringBoot以及mail的依赖包就不做解释了。
这里简单介绍下velocity的作用:
Velocity 是一个基于 Java 的模板引擎框架,提供的模板语言可以使用在 Java 中定义的对象和变量上。
作为邮件模板也是它的一个主要应用场景。
具体用法在下面会进行说明。


2.具体案例

1.使用QQ邮箱进行发送

application.properties

#发送邮箱(可以填你自己的邮箱)
email.from = xxxxxxx@qq.com
#目标邮箱
email.to = 
#邮箱服务器
email.host = smtp.qq.com
#授权码,在QQ邮箱客户端生成
email.auth = kpzmxhrkqklwbbbd

大家可能不理解auth授权码是干什么用的。
这相当于是当以第三方形式登录时用非密码验证的一种手段。
在QQ邮箱->设置->账户 往下拉可以找到。
同时需要把POP3/SMTP服务开启。
授权码


JavaMailSender

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.JavaMailSenderImpl;

import javax.mail.Authenticator;
import javax.mail.PasswordAuthentication;
import java.util.Properties;

/**
 * author   : qianweifeng
 * date     : 16/4/9.
 * describe :
 */
@Configuration
public class MailConfig {

    @Autowired
    private Environment env;

    @Bean(name = "JavaMailSender")
    public JavaMailSender getSender(){
        JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
        javaMailSender.setUsername(env.getProperty(ConfigConstant.EMAIL_FROM));
        javaMailSender.setHost(env.getProperty(ConfigConstant.EMAIL_HOST));
        javaMailSender.setPort(587);//①
        javaMailSender.setDefaultEncoding("UTF-8");
        Properties props = new Properties();//②
        props.setProperty("mail.smtp.host", env.getProperty(ConfigConstant.EMAIL_HOST));
        props.setProperty("mail.smtp.auth", "true");
        javax.mail.Session session = javax.mail.Session.getDefaultInstance(props,new Authenticator(){
            @Override
            protected PasswordAuthentication getPasswordAuthentication(){
                return new PasswordAuthentication("xxxxxx@qq.com",env.getProperty(ConfigConstant.EMAIL_AUTH));
            }
        });
        javaMailSender.setSession(session);//③
        return javaMailSender;
    }

}

这是Java邮件发送的一个具体实现Bean。
关于JavaMailSender的内容大家自行看源码或者度娘。
这里说明3个方面。
1.javaMailSender.setPort(587) 这个端口不是随意设置的,根据邮箱服务器以及协议来定的。我在网上找了相关资料,大家参考下:

2.关于Properties的设置。这里只需要设置其邮箱服务器以及启用授权码验证方式即可。

3.session完成的使用授权码验证邮件发送方,相当于建立起一个有效会话。

import com.service.config.ConfigConstant;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.SmartLifecycle;
import org.springframework.core.env.Environment;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.mail.javamail.MimeMessagePreparator;
import org.springframework.stereotype.Component;

import javax.mail.internet.MimeMessage;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * author   : qianweifeng
 * date     : 16/4/9.
 * describe :
 */
@Component
public class MailUtil implements SmartLifecycle {
    @Autowired
    private JavaMailSender javaMailSender;

    @Autowired
    private Environment env;

    private Logger logger = LoggerFactory.getLogger(MailUtil.class);

    private ScheduledExecutorService service = Executors.newScheduledThreadPool(2);

    private final AtomicInteger count = new AtomicInteger(1);

    public MimeMessagePreparator Send(final String text) {
        MimeMessagePreparator preparator = new MimeMessagePreparator() {
            public void prepare(MimeMessage mimeMessage) throws Exception {
                MimeMessageHelper message = new MimeMessageHelper(mimeMessage);
                message.setTo(env.getProperty(ConfigConstant.EMAIL_TO));
                message.setFrom(env.getProperty(ConfigConstant.EMAIL_FROM));
                message.setSubject("java email send test");
//                String text = VelocityEngineUtils.mergeTemplateIntoString(velocityEngine, "velocity/report.vm", "UTF-8", model);
                message.setText(text, true);
            }
        };
        return preparator;
    }


    @Override
    public boolean isAutoStartup() {
        return true;
    }

    @Override
    public void stop(Runnable runnable) {

    }

    @Override
    public void start() {
        service.scheduleWithFixedDelay(new Runnable() {
            @Override
            public void run() {
                try {
                    if (count.get() == 2) {
                        service.shutdown();
                        logger.info("the task is down");
                    }
                    logger.info("start send email and the index is " + count);

                    javaMailSender.send(Send("test !" + "*" + count.getAndIncrement()));

                    logger.info("send email success");
                }catch (Exception e){
                    logger.error("send email fail" , e);
                }

            }
        },2000,2000, TimeUnit.MILLISECONDS);
    }

    @Override
    public void stop() {

    }

    @Override
    public boolean isRunning() {
        return false;
    }

    @Override
    public int getPhase() {
        return 0;
    }
}

使用方式:
将邮件服务器,授权码,发送方,接受放在application.properties配置好。
项目启动后就会开始发送,总共发送2封邮件。

使用velocity来构建邮件正文

public void send(final String date, final String date2) {


        final List<UVBean> uVBean = getUV(start, end);
        final List<UserResAndLoginReport> resAndLoginReports = dao.RegisterAndLogin(start, end);

        Map model = new HashMap();
        model.put("uVBean", uVBean);
        model.put("resAndLoginReports", resAndLoginReports);
                String text = VelocityEngineUtils.mergeTemplateIntoString(velocityEngine, "velocity/report.vm", "UTF-8", model);
}
<h3>1.UV</h3>
<TABLE border="1px" style="border-collapse: collapse;">
    <TR>
        <td nowrap="nowarp" style="width:80px;" class="date">日期</td>
        <td nowrap="nowarp" style="width:120px;" class="head">UV</td>
    </TR>
    #foreach( $data in $uVBean )
        <TR>
            <TD nowrap="nowarp" class="date">${data.date}</TD>
            <TD nowrap="nowarp" class="count">${data.data}</TD>
        </TR>
    #end
</TABLE>
...

假设我们需要在邮件中显示的一些复杂内容,可以后台以对象的形式包装起来,放入一个hashmap中,在velocity解析出来,至于如何解析,那就是velocity的语义的问题了。
使用velocity可以在邮件正文中以html的方式来丰富化邮件。
可以参考这篇文章

2.使用QQ企业邮箱进行发送

过程以及代码几乎相同
区别是邮件服务器为:smtp.exmail.qq.com或者pop.exmail.qq.com
没有授权码这一概念。
发送端口号25或者SMTP协议下端口为465,POP协议下端口为995。
推荐验证方式为直接用户名+密码,或者用ssl方式进行验证。
具体参考腾讯企业邮箱客户端设置
给出一个简单的样例:

 JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
        javaMailSender.setUsername(env.getProperty("spring.mail.username"));
        javaMailSender.setHost(env.getProperty("spring.mail.host"));
        javaMailSender.setPassword(env.getProperty("spring.mail.password"));
        javaMailSender.setPort(25);
        javaMailSender.setDefaultEncoding("UTF-8");
        javaMailSender.send(preparator);

preparator就是上面出现过的MimeMessagePreparator的实例。配置方法见上。

3.总结

1.发送邮件我们首要配置的包括:邮箱服务器,协议,端口。
2.一般验证有两种方式,一种是直接的用户名密码,另一种是通过授权码或者ssl进行验证。
3.邮件的正文可以是纯文本,或者是html内容,html内容可以由velocity模板构建或者直接用字符串构建出html内容。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值