发送邮件工具类，非常实用

我就是我 2024-03-30 09:34 10阅读 0赞

说明：本示例是基于springboot工程编写的

#### 一、导入pom依赖 ####

pom.xml

<dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-email</artifactId>
                <version>1.3.3</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>easyexcel</artifactId>
                <version>3.1.3</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.apache.poi</groupId>
                        <artifactId>poi</artifactId>
                    </exclusion>
                    <exclusion>
                        <groupId>org.apache.poi</groupId>
                        <artifactId>poi-ooxml</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.12</version>
                <scope>provided</scope>
            </dependency>
            
            <dependency>
                <groupId>commons-configuration</groupId>
                <artifactId>commons-configuration</artifactId>
                <version>1.9</version>
            </dependency>

#### 二、编写邮件相关工具类 ####

EmailUtils.java

package com.zwt.utils;
    
    import com.zwt.utils.properties.PropUtils;
    import java.io.File;
    import java.util.Arrays;
    import javax.mail.internet.MimeUtility;
    import org.apache.commons.mail.Email;
    import org.apache.commons.mail.EmailAttachment;
    import org.apache.commons.mail.HtmlEmail;
    import org.apache.commons.mail.SimpleEmail;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class EmailUtils {
        
        private static final Logger LOGGER = LoggerFactory.getLogger(EmailUtils.class);
    
        //发件人邮箱
        private static String MAIL_FROM_EAMIL;
        //邮箱服务器HOST
        private static String MAIL_SMTP_HOST;
        //邮箱服务器端口号
        private static int MAIL_SMTP_PORT;
        //是否需要认证
        private static Boolean MAIL_SMTP_AUTH;
        //邮箱认证登录名
        private static String MAIL_SMTP_AUTH_USERNAME;
        //邮箱认证登录密码
        private static String MAIL_SMTP_AUTH_PASSWORD;
        //邮箱字符编码
        private static String MAIL_ENCODING;
        //是否需要SSL连接
        private static Boolean MAIL_SMTP_SSL;
        //收件人邮箱数组，new String[] { "xxx@qq.com" }
        private static String[] MAIL_RECEIVERS;
        //发件人名称
        private static String MAIL_FROM_NAME = "我是发件人";
        //邮件主题
        private static String MAIL_SUBJECT = "我是发件人主题";
        //邮件内容模板
        private static String MAIL_BODY_TEMPLATE;
        //发送邮件附件 临时存储目录
        public static String MAIL_ATTACH_TEMP_DIR="mailAttach";
        //邮件附件命名
        public static String MAIL_ATTACH_NAME = "邮件附件示例";
    
        //静态代码块，加载配置文件内容
        static {
        
            try {
        
                PropUtils config = PropUtils.getInstance();
                MAIL_RECEIVERS = config.getStringArray("mail.receivers");  //使用配置文件中的内容
                MAIL_FROM_EAMIL = config.getString("mail.from.email", "xxx@qq.com"); //这里需要根据自身情况更改
                MAIL_SMTP_HOST = config.getString("mail.smtp.host", "exchange.cn.xxx.com"); //这里需要根据自身情况更改
                MAIL_SMTP_PORT = config.getInt("mail.smtp.port", 25);
                MAIL_SMTP_AUTH = config.getBoolean("mail.smtp.auth", false);
                MAIL_SMTP_AUTH_USERNAME = config.getString("mail.smtp.username", "xxx");  //这里需要根据自身情况更改
                MAIL_SMTP_AUTH_PASSWORD = EncryptUtils.decrypt(config.getString("mail.smtp.password", "xxx")); //这里需要根据自身情况更改
                MAIL_ENCODING = config.getString("mail.encoding", "GBK");
                MAIL_SMTP_SSL = config.getBoolean("mail.smtp.ssl", false);
                MAIL_ATTACH_TEMP_DIR = config.getString("mail.attach.temp.dir", "mailAttach");
                MAIL_FROM_NAME = config.getString("supply.mail.from.name", "我是发件人"); //这里需要根据自身情况更改
                MAIL_SUBJECT = config.getString("supply.mail.summary.subject", "我是发件人主题"); //这里需要根据自身情况更改
                MAIL_BODY_TEMPLATE = config.getString("mail.body.template", "this is my test massage:\r\n\r\n%s\r\n\r\n-----------------------------\r\nThis email is sent by system automatically, do NOT reply this email directly!");
            } catch (Exception e) {
        
                LOGGER.error("Can't read application.properties", e);
            }
        }
    
    
        /**
         * 发送不带附件邮件，邮件正文不带表格
         * @param message 邮件正文消息
         */
        public static void sendCommonEmail(final String message) {
        
            try {
        
                Email email = new SimpleEmail();
                email.setHostName(MAIL_SMTP_HOST);
                email.setSmtpPort(MAIL_SMTP_PORT);
                if (MAIL_SMTP_AUTH) {
        
                    email.setAuthentication(MAIL_SMTP_AUTH_USERNAME, MAIL_SMTP_AUTH_PASSWORD);
                }
                email.setCharset(MAIL_ENCODING);
                email.setSSLOnConnect(MAIL_SMTP_SSL);
                email.setFrom(MAIL_FROM_EAMIL, MAIL_FROM_NAME);
                email.addTo(MAIL_RECEIVERS);
                email.setSubject(MAIL_SUBJECT);
                email.setMsg(String.format(MAIL_BODY_TEMPLATE, message));
                email.send();
            } catch (Exception e) {
        
                LOGGER.error(String.format(
                                "Can't send summary email: Host:%s, Port:%d, User:%s, From:%s, To:%s, Subject:%s, Message:%s",
                                MAIL_SMTP_HOST, MAIL_SMTP_PORT, MAIL_SMTP_AUTH_USERNAME, MAIL_FROM_EAMIL,
                                Arrays.toString(MAIL_RECEIVERS), MAIL_SUBJECT, message), e);
            }
        }
    
        /**
         * 发送不带附件邮件，邮件正文带表格内容
         * @param message 邮件正文消息
         */
        public static void sendHTMLEmail(final String message) {
        
            try {
        
                HtmlEmail email = new HtmlEmail();
                email.setHostName(MAIL_SMTP_HOST);
                email.setSmtpPort(MAIL_SMTP_PORT);
                email.setCharset(MAIL_ENCODING);
                if (MAIL_SMTP_AUTH) {
        
                    email.setAuthentication(MAIL_SMTP_AUTH_USERNAME, MAIL_SMTP_AUTH_PASSWORD);
                }
                email.setSSLOnConnect(MAIL_SMTP_SSL);
                email.setFrom(MAIL_FROM_EAMIL, MAIL_FROM_NAME);
                email.addTo(MAIL_RECEIVERS);
                email.setSubject(MAIL_SUBJECT);
                email.setHtmlMsg(message);
                email.setTextMsg("Your email client does not support HTML message.");
                email.send();
            } catch (Exception e) {
        
                LOGGER.error(String.format(
                                "Can't send summary email: Host:%s, Port:%d, User:%s, From:%s, To:%s, Subject:%s, Message:%s",
                                MAIL_SMTP_HOST, MAIL_SMTP_PORT, MAIL_SMTP_AUTH_USERNAME, MAIL_FROM_EAMIL,
                                Arrays.toString(MAIL_RECEIVERS), MAIL_SUBJECT, message), e);
            }
        }
    
        /**
         * 发送附件邮件
         * @param message 邮件正文消息
         * @param fileName 附件全路径 dir+attachName
         * @param attachName 附件名 示例：邮件附件示例2022-12-16.xlsl
         */
        public static void sendEmailWithAttach(final String message,String fileName,String attachName) {
        
            try {
        
                HtmlEmail email = new HtmlEmail();
                email.setHostName(MAIL_SMTP_HOST);      //指定邮件服务器
                email.setSmtpPort(MAIL_SMTP_PORT);         //端口
                email.setCharset(MAIL_ENCODING);           //字符集
                if (MAIL_SMTP_AUTH) {
        
                    email.setAuthentication(MAIL_SMTP_AUTH_USERNAME, MAIL_SMTP_AUTH_PASSWORD);  //身份验证
                }
                email.setSSLOnConnect(MAIL_SMTP_SSL);
                email.setFrom(MAIL_FROM_EAMIL, MAIL_FROM_NAME);       //邮件发送人
                EmailAttachment emailAttachment = new EmailAttachment();        //附件对象
                emailAttachment.setPath(fileName);          //附件路径
                emailAttachment.setName(MimeUtility.encodeText(fileName));
                emailAttachment.setDisposition(EmailAttachment.ATTACHMENT);
                emailAttachment.setDescription(attachName);     //附件名称
                email.attach(emailAttachment);          //发送附件
                email.addTo(MAIL_RECEIVERS);      //收件人
                email.setSubject(MAIL_SUBJECT);       //主题
                email.setHtmlMsg(message);          //邮件正文
                email.setTextMsg("Your email client does not support HTML message.");
                email.send();
    
                // 删除临时目录中的附件
                File file = new File(fileName);
                if (file.delete()){
        
                    LOGGER.info("---附件删除成功---fileName："+fileName);
                }else {
        
                    LOGGER.info("---附件删除失败---fileName："+fileName);
                }
            } catch (Exception e) {
        
                LOGGER.error(String.format(
                        "Can't send summary email: Host:%s, Port:%d, User:%s, From:%s, To:%s, Subject:%s, Message:%s",
                        MAIL_SMTP_HOST, MAIL_SMTP_PORT, MAIL_SMTP_AUTH_USERNAME, MAIL_FROM_EAMIL,
                        Arrays.toString(MAIL_RECEIVERS), MAIL_SUBJECT, message), e);
            }
        }
    
    }

EncryptUtils.java

package com.zwt.utils;
    
    import com.zwt.utils.properties.PropUtils;
    import java.util.Scanner;
    import javax.crypto.Cipher;
    import javax.crypto.spec.SecretKeySpec;
    import org.apache.commons.codec.binary.Base64;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    
    /**
     * AES加解密工具类
     */
    public class EncryptUtils {
        
    
        private static final Logger log = LoggerFactory.getLogger(EncryptUtils.class);
    
        private static String TOKEN;
    
        static {
        
            PropUtils config = PropUtils.getInstance();
            TOKEN = config.getString("encry.token");
            if (TOKEN == null || TOKEN.trim().length() != 16) {
        
                TOKEN = null;
                throw new RuntimeException(
                        "Invalid token string! Token can't be blank and length must be 16!");
            }
        }
    
        private static final SecretKeySpec key = new SecretKeySpec(TOKEN.trim().getBytes(), "AES");
    
        private static String encodeBase64(byte[] msg) {
        
            Base64 encoder = new Base64();
            return encoder.encodeToString(msg);
        }
    
        private static byte[] decodeBase64(String msg) {
        
            Base64 decoder = new Base64();
            return decoder.decode(msg);
        }
    
        /**
         * 加密
         * @param p 明文
         * @return
         * @throws Exception
         */
        public static String encrypt(String p) throws Exception {
        
            if (TOKEN == null) {
        
                throw new RuntimeException("Can't encrypt password because token is invalid!");
            }
            Cipher cipher = Cipher.getInstance("AES");
            byte[] byteContent = p.getBytes("UTF-8");
            cipher.init(Cipher.ENCRYPT_MODE, key);
            byte[] result = cipher.doFinal(byteContent);
            return encodeBase64(result);
        }
    
        /**
         * 解密
         * @param p 密文
         * @return
         * @throws Exception
         */
        public static String decrypt(String p) throws Exception {
        
            if (TOKEN == null) {
        
                throw new RuntimeException("Can't decrypt password because token is invalid!");
            }
            Cipher cipher = Cipher.getInstance("AES");
            cipher.init(Cipher.DECRYPT_MODE, key);
            return new String(cipher.doFinal(decodeBase64(p)), "UTF-8");
        }
    
        /**
         * 加密
         * @param p 原文
         * @param token
         * @return
         * @throws Exception
         */
        public static String encrypt(String p, String token) throws Exception {
        
            SecretKeySpec key = new SecretKeySpec(token.trim().getBytes(), "AES");
            Cipher cipher = Cipher.getInstance("AES");
            byte[] byteContent = p.getBytes("UTF-8");
            cipher.init(Cipher.ENCRYPT_MODE, key);
            byte[] result = cipher.doFinal(byteContent);
            return encodeBase64(result);
        }
    
        /**
         * 解密
         * @param p 密文
         * @param token
         * @return
         * @throws Exception
         */
        public static String decrypt(String p, String token) throws Exception {
        
            SecretKeySpec key = new SecretKeySpec(token.trim().getBytes(), "AES");
            Cipher cipher = Cipher.getInstance("AES");
            cipher.init(Cipher.DECRYPT_MODE, key);
            return new String(cipher.doFinal(decodeBase64(p)), "UTF-8");
        }
    
        // 测试
        public static void main(String[] args) throws Exception {
        
    
            log.info("Please input original password: ");
            //原始字符串
            try (Scanner in = new Scanner(System.in)) {
        
                // 加密后
                String encryptedStr = encrypt(in.nextLine());
                log.info("Encrypted password: {}", encryptedStr);
    
                //解密后：
                log.info("Original password: {}", decrypt(encryptedStr));
            } catch (Exception e) {
        
                log.error("Encrypt/Decrypt error:{}", e.getMessage());
            }
    
        }
    }

PropUtils.java

package com.zwt.utils.properties;
    
    import org.apache.commons.configuration.ConfigurationException;
    import org.apache.commons.configuration.PropertiesConfiguration;
    
    /**
     * 加载配置文件工具类
     */
    public class PropUtils {
        
        private PropertiesConfiguration props = null;
    
        private static class LazyHolder {
        
            public static final PropUtils instance = new PropUtils();
        }
    
        public static PropUtils getInstance() {
        
            return LazyHolder.instance;
        }
    
        private PropUtils() {
        
            try {
        
                props = new PropertiesConfiguration("application.yml");
                props.setThrowExceptionOnMissing(true);
            } catch (ConfigurationException e) {
        
                throw new RuntimeException(String.format("Failed to load application.yml.[exception = %s]", e.getMessage()), e);
            }
        }
    
        public String getString(String key) {
        
            return props.getString(key);
        }
    
        public String getString(String key, String defaultValue) {
        
            return props.getString(key, defaultValue);
        }
    
        public int getInt(String key) {
        
            return props.getInt(key);
        }
    
        public int getInt(String key, int defaultValue) {
        
            return props.getInt(key, defaultValue);
        }
    
        public String[] getStringArray(String key) {
        
            return props.getStringArray(key);
        }
    
        public boolean getBoolean(String key, boolean defaultValue) {
        
            return props.getBoolean(key, defaultValue);
        }
    
        public short getShort(String key, Short defaultValue) {
        
            return props.getShort(key, defaultValue);
        }
    
        public Object getProperty(String key){
        
            return props.getProperty(key);
        }
    }

#### 三、配置文件增加配置 ####

src/main/resources/application.yml

#AES加解密所需token，自定义16位字符串
    encry.token: 1234567890123456
    # Mail相关配置，根据自身情况修改
    mail.from.email: xxx@qq.com
    mail.from.name: 我是发件人
    mail.smtp.host: exchange.cn.xxx.com
    mail.smtp.port: 25
    mail.smtp.auth: false
    mail.smtp.username: xxx
    mail.smtp.password: cu3h+NJlT5Uf4L1fRNyTVQ==
    mail.encoding: GBK
    mail.smtp.ssl: false
    mail.subject: 我是发件人主题
    mail.body.template: this is my test massage:\r\n\r\n%s\r\n\r\n-----------------------------\r\nThis email is sent by system automatically\, do NOT reply this email directly!
    mail.receivers: xxx@qq.com
    mail.attach.temp.dir: mailAttach

#### 四、编写测试类 ####

src/test/java/com/zwt/springboottest/SpringboottestApplicationTests.java

package com.zwt.springboottest;
    
    import com.alibaba.excel.EasyExcel;
    import com.zwt.pojo.UserExcel;
    import com.zwt.utils.EmailUtils;
    import com.zwt.utils.properties.ValuePropsTest;
    import java.io.File;
    import java.io.FileNotFoundException;
    import java.text.SimpleDateFormat;
    import java.util.ArrayList;
    import java.util.Date;
    import java.util.List;
    import java.util.Objects;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.commons.collections4.CollectionUtils;
    import org.apache.commons.lang.ArrayUtils;
    import org.apache.commons.lang.StringUtils;
    import org.junit.jupiter.api.Test;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.util.ResourceUtils;
    
    @SpringBootTest
    @Slf4j
    class SpringboottestApplicationTests {
        
    
        /**
         * 发送常规邮件测试
         */
        @Test
        void sendCommonEmailTest() {
        
            String message = "我是邮件正文哦，可以随意写内容。";
            EmailUtils.sendCommonEmail(message);
        }
    
        /**
         * 发送正文是表格的邮件测试
         */
        @Test
        void sendHTMLEmailTest() {
        
            //邮件正文字符串，需要组装成html表格
            StringBuilder sb = new StringBuilder();
            sb.append("这是我发送的邮件正文");
            //换行符
            sb.append("</br>");
            //增加一条分割线
            sb.append("<hr size=1>");
    
            //表1：模拟数据列表，这里测试，直接创建假数据。开发中可以当作参数传入
            String[] headers1 = new String[]{
        "ID", "姓名", "年龄", "性别", "操作人ID", "操作日期"};
            List<Object[]> dataList1 = new ArrayList<>();
            String optTime1 = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
            dataList1.add(new Object[]{
        1,"张三",18,"男","123",optTime1});
            dataList1.add(new Object[]{
        2,"李芳",20,"女","456",optTime1});
            //表1:创建HTML格式
            sb.append(createHTMLTable(dataList1, "用户列表:", "", headers1));
            sb.append("</br>");
    
            //表2:模拟数据列表，这里测试，直接创建假数据。开发中可以当作参数传入
            String[] headers2 = new String[]{
        "公司", "部门", "姓名", "入职时间"};
            List<Object[]> dataList2 = new ArrayList<>();
            dataList2.add(new Object[]{
        "拼西西科技","科技部","男",optTime1});
            dataList2.add(new Object[]{
        "藤喜科技","财务部","女",optTime1});
            sb.append(createHTMLTable(dataList2, "员工列表:", "", headers2));
            sb.append("</br>");
    
            //发送带表格邮件
            EmailUtils.sendHTMLEmail(sb.toString());
        }
    
        /**
         * 创建HTML表格格式公共方法
         * @param data 数据列表
         * @param title 表格标题
         * @param titleBGColor 标题背景色
         * @param headers 表头
         * @return
         */
        private String createHTMLTable(List<Object[]> data, String title, String titleBGColor, String[] headers) {
        
            if (CollectionUtils.isEmpty(data)) {
        
                return StringUtils.EMPTY;
            }
            StringBuilder sb = new StringBuilder();
            sb.append("<table border='1'>");
            if (StringUtils.isNotEmpty(title)) {
        
                sb.append(String.format("<tr><td colspan=%d bgcolor='%s'><strong>", headers.length, titleBGColor)).append(title).append("</strong></td></tr>");
            }
    
            if (ArrayUtils.isNotEmpty(headers)) {
        
                sb.append("<tr>");
                for (String head : headers) {
        
                    sb.append("<td>").append(head).append("</td>");
                }
                sb.append("</tr>");
            }
    
            if (CollectionUtils.isNotEmpty(data)) {
        
                for (Object[] row : data) {
        
                    sb.append("<tr>");
                    for (Object col : row) {
        
                        try {
        
                            sb.append("<td>").append(Objects.isNull(col) ? "" : col.toString()).append("</td>");
                        } catch (Exception e) {
        
                            log.error(e.getMessage(), e);
                        }
                    }
                    sb.append("</tr>");
                }
            }
    
            sb.append("</table>");
            return sb.toString();
        }
    
        /**
         * 发送带附件邮件测试
         */
        @Test
        void sendEmailWithAttachTest() {
        
            // 模拟数据列表，这里测试，直接创建假数据。开发中可以当作参数传入
            List<UserExcel> userExcelList = new ArrayList<>();
            String optTime1 = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
            userExcelList.add(new UserExcel(1,"张三",18,"男","123",optTime1));
            userExcelList.add(new UserExcel(2,"李芳",20,"女","456",optTime1));
    
            // 创建本地文件目录
            String path = null;
            try {
        
                path = ResourceUtils.getURL("classpath:").getPath();
            } catch (FileNotFoundException e) {
        
                log.error("文件目录未找到异常：",e);
                throw new RuntimeException(e);
            }
            String attachTempDir = path + EmailUtils.MAIL_ATTACH_TEMP_DIR+"/";
            File file = new File(attachTempDir);
            if (!file.exists()) {
        
                file.mkdirs();
            }
    
            // 获取文件全路径
            SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
            String attachName = EmailUtils.MAIL_ATTACH_NAME + dateFormat.format(new Date())+".xlsx";
            String fileName = attachTempDir + attachName;
    
            // 填充附件内容
            EasyExcel.write(fileName,UserExcel.class).sheet(EmailUtils.MAIL_ATTACH_NAME).doWrite(userExcelList);
    
            /**以下是创建多个sheet示例 */
    //        try {
        
    //            //填充sheet1
    //            WriteSheet writeSheet1 = new WriteSheet();
    //            writeSheet1.setSheetName("sheet1名称");
    //            writeSheet1.setClazz(UserExcel.class);
    //            excelWriter.write(userExcelList, writeSheet1);
    //            //填充sheet2
    //            WriteSheet writeSheet2 = new WriteSheet();
    //            writeSheet2.setSheetName("sheet2名称");
    //            writeSheet2.setClazz(UserExcel.class);
    //            excelWriter.write(userExcelList, writeSheet2);
    //        }finally {
        
    //            excelWriter.finish();
    //        }
    
            // 发送邮件
            EmailUtils.sendEmailWithAttach("这是我发送的邮件正文",fileName,attachName);
        }
    
    }

#### 五、运行测试结果 ####

1、普通邮件  
![在这里插入图片描述][20124846d25c4277b67360ea39ef76c9.png]

2、正文带表格邮件  
![在这里插入图片描述][3141c425242a43158654031bb57cc433.png]

3、带附件邮件  
![在这里插入图片描述][a65cc21dc66a49b6a56e12b7ba29ba4d.png]  
附件内容  
![在这里插入图片描述][86d304c48320457c850df6395379bec7.png]

[20124846d25c4277b67360ea39ef76c9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/b7515af0a7e74d868fe8c9c3cb0de670.png
[3141c425242a43158654031bb57cc433.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/ed87865369df4d06a5d2aad1dc9d567f.png
[a65cc21dc66a49b6a56e12b7ba29ba4d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/b56d86e1c35b4fcb921392ef8ae3f405.png
[86d304c48320457c850df6395379bec7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/a8baa48eaf7b4a85954a63e3920fe03f.png