84 lines
2.8 KiB
Markdown
84 lines
2.8 KiB
Markdown
# PMail
|
||
|
||
> A server, a domain, a line of code, a minute, and you'll be able to build a domain mailbox of your own.
|
||
|
||
## [中文文档](./README_CN.md)
|
||
|
||
## Introduction
|
||
|
||
PMail is a personal email server that pursues a minimal deployment process and extreme resource consumption. It runs on
|
||
a single file and contains complete send/receive mail service and web-side mail management functions. Just a server , a
|
||
domain name , a line of code , a minute of deployment time , you will be able to build a domain name mailbox of your
|
||
own .
|
||
|
||
All kinds of PR are welcome, whether you are fixing bugs, adding features, or optimizing translations. Also, call for a
|
||
beautiful and cute Logo for this project!
|
||
|
||
<img src="./docs/en.gif" alt="Editor" width="800px">
|
||
|
||
## Features
|
||
|
||
* Single file operation and easy deployment.
|
||
|
||
* The binary file is only 15MB and takes up less than 10M of memory during the run.
|
||
|
||
* Support dkim, spf checksum, [Email Test](https://www.mail-tester.com/) score 10 points if correctly configured.
|
||
|
||
* Implementing the ACME protocol, the program will automatically obtain and update Let's Encrypt certificates.
|
||
|
||
> By default, a ssl certificate is generated for the web service, allowing pages to use the https protocol.
|
||
> If you have your own gateway or don't need https, set `httpsEnabled` to `2` in the configuration file so that the web
|
||
> service will not use https.
|
||
(Note: Even if you don't need https, please make sure the path to the ssl certificate file is correct, although the web
|
||
> service doesn't use the certificate anymore, the smtp protocol still needs the certificate)
|
||
|
||
## Disadvantages
|
||
|
||
* At present, only the core function of sending and receiving emails has been completed. Basically, it can only be used
|
||
by a single person, and does not deal with issues related to permission management in the process of multiple users.
|
||
|
||
* The UI is ugly
|
||
|
||
# How to run
|
||
|
||
## 1、Download
|
||
|
||
* [Click Here](https://github.com/Jinnrry/PMail/releases) Download a program file that matches you.
|
||
|
||
* Or use Docker `docker pull ghcr.io/jinnrry/pmail:latest`
|
||
|
||
## 2、Run
|
||
|
||
`double-click to open` Or `execute command to run`
|
||
|
||
## 3、Configuration
|
||
|
||
Open `http://127.0.0.1` in your browser or use your server's public IP to visit, then follow the instructions to
|
||
configure.
|
||
|
||
## 4、Email Test
|
||
|
||
Check if your mailbox has completed all the security configuration. It is recommended to
|
||
use [https://www.mail-tester.com/](https://www.mail-tester.com/) for checking.
|
||
|
||
## 5、 WeChat Message Push
|
||
|
||
Open the `config/config.json` file in the run directory, edit a few configuration items at the beginning of `weChatPush`
|
||
and restart the service.
|
||
|
||
# For Developer
|
||
|
||
## Project Framework
|
||
|
||
1、 FE： vue3+element-plus
|
||
|
||
The code is in `fe` folder.
|
||
|
||
2、Server： golang + mysql
|
||
|
||
The code is in `server` folder.
|
||
|
||
## Plugin Development
|
||
|
||
Reference this file. `server/hooks/wechat_push/wechat_push.go`
|