[SpringBoot实战系列]实现发送邮件API/发件人中文别名

喜欢ヅ旅行 2022-02-14 02:11 151阅读 0赞

![16a53ace29fb651d_w_1078_h_459_f_png_s_317446][]

# 前言 #

由于[价格监控项目][Link 1]的需求，实现了一个小的邮件发送接口服务，使用了一个单独的SpringBoot项目，给他取名为spring-mail-sender，开源在了Github上。内部我给他命名为**提醒服务**，因为未来希望还能扩展下，用来做短信发送服务，或者安卓等推送服务的API。

# 简介 #

本项目使用springboot，采用web api的方式提供邮件，短信等服务的调用接口，目前仅支持邮件提醒。

[https://github.com/qqxx6661/spring-mail-sender][https_github.com_qqxx6661_spring-mail-sender]

邮件提醒特点：

*  本地配置文件设置邮件账户密码和smtp
 *  使用post来调用发送邮件请求，post中使用json数据填充：发件人昵称，收件人昵称，收件人邮箱，主题，正文。
 *  调用接口返回状态码定义：(1=正常，2=错误，3=未登录，4=自定义错误（直接抛出errorMes）)
 *  发件人，收件人支持别名。

本项目待完成：

*  调用接口鉴权：防止无权限人员调用
 *  调用接口频率限制：防止滥用接口
 *  调用日志存储

项目结构如下：

├─main
    │  ├─java
    │  │  └─com
    │  │      └─demo
    │  │          └─springmailsender
    │  │              │  SpringMailSenderApplication.java
    │  │              │  SwaggerConfig.java
    │  │              │
    │  │              ├─domain
    │  │              │      EmailRequest.java
    │  │              │      ResponseData.java
    │  │              │
    │  │              ├─service
    │  │              │      EmailService.java
    │  │              │      EmailServiceImpl.java
    │  │              │
    │  │              └─web
    │  │                      EmailController.java
    │  │
    │  └─resources
    │          application.properties
    │
    └─test
        └─java
            └─com
                └─demo
                    └─springmailsender
                            SpringMailSenderApplicationTests.java

# 问题解决 #

## 发件人无法自定义别名 ##

发现邮件发件人，也就是`simpleMailMessage.setFrom`只能以用户的邮箱地址作为昵称，发件效果是这样的：

{
      "address": "xxxxx@qq.com",
      "from": "2897788509@qq.com", // 必须和发件邮箱完全一致
      "msg": "string",
      "subject": "string",
      "to": "xxxxxxx@qq.com"
    }

如果不一致，或者填写了用户别名，就会报如下错误：

![16a53a94e54ff57e_w_957_h_197_f_png_s_13936][]

我就很纳闷，因为之前我用python写了个发送邮件的api，明明是可以别名的啊，于是我打开了python的邮件api，看到如下代码，我将名称编码为了UTF-8：

@staticmethod
        def _format_addr(s):
            # format the email address
            name, addr = parseaddr(s)
            return formataddr((Header(name, 'utf-8').encode(), addr))

随后我又去谷歌了一阵，参考：

[https://blog.csdn.net/yiifaa/article/details/78264962][https_blog.csdn.net_yiifaa_article_details_78264962]

原来想要使用发件人别名，就必须对发件字段进行编码：

**严格格式为：别名<邮件地址>**

![16a53a924471efd6_w_732_h_375_f_png_s_40350][]

然而，网上很多种答案要么引入了`new InternetAddress(alias + " <"+from+">")`,要么编码为GBK，我最后还是直接编码为UTF-8：

String fromByte = new String((emailRequest.getFrom() + " <" + fromAddress + ">")
                    .getBytes("UTF-8"));
            String toByte = new String((emailRequest.getTo() + " <" + emailRequest.getAddress() + ">")
                    .getBytes("UTF-8"));
            simpleMailMessage.setFrom(fromByte);
            simpleMailMessage.setTo(toByte);
            simpleMailMessage.setSubject(emailRequest.getSubject());
            simpleMailMessage.setText(emailRequest.getMsg());

大功告成：

![16a53a8f777e8ea8_w_365_h_239_f_png_s_18839][]

# 关注我 #

我目前是一名后端开发工程师。技术领域主要关注后端开发，数据爬虫，数据安全，5G，物联网等方向。

微信：yangzd1102

Github：[@qqxx6661][qqxx6661]

个人博客：

*  CSDN：[@qqxx6661][qqxx6661 1]
 *  知乎：[@Zhendong][Zhendong]
 *  简书：[@蛮三刀把刀][Link 2]
 *  掘金：[@蛮三刀把刀][Link 3]

### 原创博客主要内容 ###

*  Java知识点复习全手册
 *  Leetcode算法题解析
 *  剑指offer算法题解析
 *  SpringCloud菜鸟入门实战系列
 *  SpringBoot菜鸟入门实战系列
 *  Python爬虫相关技术文章
 *  后端开发相关技术文章

### 个人公众号：Rude3Knife ###

![个人公众号：Rude3Knife][Rude3Knife]

**如果文章对你有帮助，不妨收藏起来并转发给您的朋友们~**

[16a53ace29fb651d_w_1078_h_459_f_png_s_317446]: https://user-gold-cdn.xitu.io/2019/4/25/16a53ace29fb651d?w=1078&h=459&f=png&s=317446
[Link 1]: https://blog.csdn.net/qqxx6661/article/details/85301787
[https_github.com_qqxx6661_spring-mail-sender]: https://github.com/qqxx6661/spring-mail-sender
[16a53a94e54ff57e_w_957_h_197_f_png_s_13936]: https://user-gold-cdn.xitu.io/2019/4/25/16a53a94e54ff57e?w=957&h=197&f=png&s=13936
[https_blog.csdn.net_yiifaa_article_details_78264962]: https://blog.csdn.net/yiifaa/article/details/78264962
[16a53a924471efd6_w_732_h_375_f_png_s_40350]: https://user-gold-cdn.xitu.io/2019/4/25/16a53a924471efd6?w=732&h=375&f=png&s=40350
[16a53a8f777e8ea8_w_365_h_239_f_png_s_18839]: https://user-gold-cdn.xitu.io/2019/4/25/16a53a8f777e8ea8?w=365&h=239&f=png&s=18839
[qqxx6661]: https://github.com/qqxx6661
[qqxx6661 1]: http://blog.csdn.net/qqxx6661
[Zhendong]: https://www.zhihu.com/people/yang-zhen-dong-1/
[Link 2]: https://www.jianshu.com/u/b5f225ca2376
[Link 3]: https://juejin.im/user/5b48015ce51d45191462ba55
[Rude3Knife]: https://user-gold-cdn.xitu.io/2019/4/19/16a34a96b401f1ef?w=263&h=265&f=png&s=44022