141 lines
4.6 KiB
Markdown
141 lines
4.6 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)
|
||
|
||
I'm Chinese, and I'm not good at English, so I apologise for my translation.
|
||
|
||
## 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)
|
||
|
||
* Support pop3, smtp protocol, you can use any mail client you like.
|
||
|
||
|
||
|
||
# How to run
|
||
|
||
## 0、Check You IP / Domain
|
||
|
||
First go to [spamhaus](https://check.spamhaus.org/) and check your domain name and server IP for blocking records
|
||
|
||
## 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
|
||
|
||
`./pmail` (Set the http port for the initialization interface with `-p` )
|
||
|
||
Or
|
||
|
||
`docker run -p 25:25 -p 80:80 -p 443:443 -p 110:110 -p 465:465 -p 995:995 -v $(pwd)/config:/work/config ghcr.io/jinnrry/pmail:latest`
|
||
|
||
> [!IMPORTANT]
|
||
> If your server has a firewall turned on, you need to open ports 25, 80, 110, 443, 465, 995
|
||
|
||
## 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.
|
||
|
||
|
||
# Configuration file format description
|
||
|
||
```json
|
||
{
|
||
"logLevel": "info", //log output level
|
||
"domain": "domain.com", // Your domain
|
||
"webDomain": "mail.domain.com", // web domain
|
||
"dkimPrivateKeyPath": "config/dkim/dkim.priv", // dkim key path
|
||
"sslType": "0", // ssl certificate update mode, 0 automatic, 1 manual
|
||
"SSLPrivateKeyPath": "config/ssl/private.key", // ssl certificate path
|
||
"SSLPublicKeyPath": "config/ssl/public.crt", // ssl certificate path
|
||
"dbDSN": "./config/pmail.db", // database connect DSN
|
||
"dbType": "sqlite", //database type ，`sqlite` or `mysql`
|
||
"httpsEnabled": 0, // enabled https , 0:enabled 1:enablde 2:disenabled
|
||
"httpPort": 80, // http port . default 80
|
||
"httpsPort": 443, // https port . default 443
|
||
"spamFilterLevel": 0,// Spam filter level, 0: no filter, 1: filtering when `spf` and `dkim` don't pass, 2: filtering when `spf` don't pass
|
||
"isInit": true // If false, it will enter the bootstrap process.
|
||
}
|
||
```
|
||
|
||
# Mail Client Configuration
|
||
|
||
POP3 Server Address : pop.[Your Domain]
|
||
|
||
POP3 Port: 110/995(SSL)
|
||
|
||
SMTP Server Address : smtp.[Your Domain]
|
||
|
||
SMTP Port: 25/465(SSL)
|
||
|
||
# Plugin
|
||
|
||
[WeChat Push](server/hooks/wechat_push/README.md)
|
||
|
||
[Telegram Push](server/hooks/telegram_push/README.md)
|
||
|
||
[Web Push](server/hooks/web_push/README.md)
|
||
|
||
## Plugin Install
|
||
> [!IMPORTANT]
|
||
> Plugins run on your server as independent processes, please review the security of third-party plugins on your own.PMail currently only maintains the three plugins mentioned above.
|
||
|
||
Copy plugin binary file to `/plugins`
|
||
|
||
# For Developer
|
||
|
||
## Project Framework
|
||
|
||
1、 FE： vue3+element-plus
|
||
|
||
The code is in `fe` folder.
|
||
|
||
2、Server： golang + MySQL/SQLite
|
||
|
||
The code is in `server` folder.
|
||
|
||
3、How to build
|
||
|
||
`make build`
|
||
|
||
|
||
## Api Documentation
|
||
|
||
[go to wiki](https://github.com/Jinnrry/PMail/wiki/%E5%90%8E%E7%AB%AF%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3)
|
||
|
||
## Plugin Development
|
||
|
||
[go to wiki](https://github.com/Jinnrry/PMail/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E)
|
||
|