|
1 | | -# 序言 |
| 1 | +## 序言 |
2 | 2 | 本次主要使用 `golang` 重写 `email` 模块 |
3 | 3 |
|
| 4 | + |
| 5 | +## 使用 |
| 6 | + |
| 7 | +#### 发送邮件 |
| 8 | + |
| 9 | +- API `127.0.0.1:8100/api/email/send` |
| 10 | +- 方式 `POST` |
| 11 | +- 入参 |
| 12 | + - `title` 邮件名 |
| 13 | + - `content` 待发送正文,支持html |
| 14 | + - `sender_name` string 发件人昵称 |
| 15 | + - `receiver` string 接收者邮箱.多个以逗号隔开 |
| 16 | + - `receiver_name` string 接收者邮箱昵称,可以不填,多个以逗号隔开 |
| 17 | + - `attachment[]` file 多个附件请使用相同变量名.请使用 form-data 进行传输 |
| 18 | + |
| 19 | +###### 示例:正常请求 |
| 20 | + |
| 21 | +~~~bash |
| 22 | +{ |
| 23 | + "code": 200, |
| 24 | + "message": "success", |
| 25 | + "data": null |
| 26 | +} |
| 27 | +~~~ |
| 28 | + |
| 29 | +###### 示例:异常请求 |
| 30 | + |
| 31 | +~~~bash |
| 32 | +{ |
| 33 | + "code": 400, |
| 34 | + "message": "Param is invalid", |
| 35 | + "data": null |
| 36 | +} |
| 37 | +~~~ |
| 38 | + |
| 39 | +###### 请求邮件通知服务 |
| 40 | + |
| 41 | + |
| 42 | +`图 001` |
| 43 | + |
| 44 | +###### 接收邮件 |
| 45 | + |
| 46 | + |
| 47 | +`图 002` |
| 48 | + |
| 49 | + |
| 50 | + |
4 | 51 | ###### 注意 |
5 | 52 | 文件大小限制请在服务器层面完成,如 `nginx` |
6 | 53 | 目前属于单机部署版本,只因为附件是临时存储到本地的 |
@@ -77,53 +124,8 @@ make tool |
77 | 124 |
|
78 | 125 | ~~~bash |
79 | 126 | make deploy |
80 | | -./email_server |
81 | 127 | ~~~ |
82 | 128 |
|
83 | | -## 使用 |
84 | | - |
85 | | -#### 发送邮件 |
86 | | - |
87 | | -- API `127.0.0.1:8100/api/email/send` |
88 | | -- 方式 `POST` |
89 | | -- 入参 |
90 | | - - `title` 邮件名 |
91 | | - - `content` 待发送正文,支持html |
92 | | - - `sender_name` string 发件人昵称 |
93 | | - - `receiver` string 接收者邮箱.多个以逗号隔开 |
94 | | - - `receiver_name` string 接收者邮箱昵称,可以不填,多个以逗号隔开 |
95 | | - - `attachment[]` file 多个附件请使用相同变量名.请使用 form-data 进行传输 |
96 | | - |
97 | | -###### 示例:正常请求 |
98 | | - |
99 | | -~~~bash |
100 | | -{ |
101 | | - "code": 200, |
102 | | - "message": "success", |
103 | | - "data": null |
104 | | -} |
105 | | -~~~ |
106 | | - |
107 | | -###### 示例:异常请求 |
108 | | - |
109 | | -~~~bash |
110 | | -{ |
111 | | - "code": 400, |
112 | | - "message": "Param is invalid", |
113 | | - "data": null |
114 | | -} |
115 | | -~~~ |
116 | | - |
117 | | -###### 请求邮件通知服务 |
118 | | - |
119 | | - |
120 | | -`图 001` |
121 | | - |
122 | | -###### 接收邮件 |
123 | | - |
124 | | - |
125 | | -`图 002` |
126 | | - |
127 | 129 |
|
128 | 130 | #### supervisor 配置 |
129 | 131 |
|
|
0 commit comments