# EmailUtil

**Repository Path**: dounineli/EmailUtil

## Basic Information

- **Project Name**: EmailUtil
- **Description**: 一个基于apache.commons.mail库发送邮件的小工具
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-12
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EmailUtil

## 0. 介绍

`EmailUtil`: a util of sending email
`PropertyUtil`: a util of reading .properties

## 1. EmailUtil使用

### 1.1. 实例化

实例化`EmailUtil`类，有两种方法：

#### 1.1.1. 方法一

实例化时，通过构造函数传入邮件服务器的信息：

```java
/**
 * 构造函数，设置邮件服务器相关信息
 * @param host 邮件服务器地址
 * @param port 邮件服务器端口
 * @param username 登录邮件服务器的用户名
 * @param passwd 登录邮件服务器的密码
 * @throws Exception 当存在为空项时，抛出异常
 */
public EmailUtil(String host, String port, String username, String passwd) throws Exception {}
```

#### 1.1.2. 方法二

通过读取`config.properties`配置文件中邮件服务器的信息，进行实例化

```java
/**
 * 构造函数，从配置文件中获取邮件服务器的相关信息
 * @throws Exception 当配置文件不能打开，或者配置文件信息有误时，抛出异常
 */
public EmailUtil() throws Exception {}
```

`config.properties`配置文件在`src\main\resource`目录下，需用户自行创建，其中需填写的信息示例如下：

```properties
# qq邮件服务器
email.host = smtp.qq.com
email.port = 465
email.username = xxxxxxxx@qq.com
email.passwd = xxxxxxxxxxxxxxx # 16位授权码
```

### 1.2. 发送邮件

调用`send()`方法即可，该方法调用规约如下：

```java
/**
 * 发送邮件
 * @param fromEmail 发件人Email
 * @param toEmail 收件人Email
 * @param subject 主题
 * @param msg 内容
 * @return
 *      true: send successfully
 *      false: send fail
 */
public boolean send(String fromEmail, String toEmail, String subject, String msg) {}
```

## 2. 测试

在`EmailUtilTest`中：

- 对`apache.commons.mail`库中的`SimpleEmail.setFrom()`函数进行了单元测试

- 对`EmailUtil.isEmpty()`函数进行了单元测试

- 对`EmailUtil.send()`函数进行了单元测试

- 对`EmailUtil.send()`函数进行了集成测试