Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vwh/vwh-email
Temp mail service, anonymously and free
https://github.com/vwh/vwh-email
email-api email-notification free-email temp-email temp-mail temp-mail-api temp-mail-website
Last synced: about 1 month ago
JSON representation
Temp mail service, anonymously and free
- Host: GitHub
- URL: https://github.com/vwh/vwh-email
- Owner: vwh
- License: mit
- Created: 2024-10-29T18:55:51.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-19T14:18:03.000Z (about 1 month ago)
- Last Synced: 2024-11-19T15:20:23.268Z (about 1 month ago)
- Topics: email-api, email-notification, free-email, temp-email, temp-mail, temp-mail-api, temp-mail-website
- Language: TypeScript
- Homepage: https://email.vwh.sh
- Size: 992 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VWH Email
Open-source temporary email service that provides quick, anonymous email solutions.
[](https://github.com/vwh/sqlite-viewer/blob/main/LICENSE)
[](https://github.com/vwh/vwh-email/actions/workflows/format.yml)
[](https://github.com/vwh/vwh-email/actions/workflows/lint.yml)
---
## Dockerized Installation (Coming Soon)
**Status: Under Development**
- Complete Docker containerization is in progress
- Will include Postfix mail server
- One-click deployment
- Simplified configuration
- Expected features:
- Pre-configured Postfix
- Integrated webhook
- Easy environment setup
## Manual Installation
### Prerequisites
- **Domain**: vwh.sh
- **DNS Provider**: Cloudflare
- **Server**: Ubuntu VPS
- **Mail Server Software**: Postfix
---
### Step 1: DNS Configuration (Cloudflare)
1. Log in to your Cloudflare account
2. Select your domain (vwh.sh)
**Note**: In all the following steps, replace `vwh.sh` with your domain name.
3. Go to the DNS settings
4. Add the following records:
- MX record:
- Name: `@`
- Value: `mail.vwh.sh`
- Priority: 10
- A record:
- Name: `mail`
- Value: `[Your VPS IP address]`
- TXT record (for SPF):
- Name: `@`
- Value: `v=spf1 mx ~all`
---
### Step 2: VPS Setup
1. SSH into your Ubuntu VPS
2. Update the system:
```bash
sudo apt update && sudo apt upgrade -y
```
3. Set the hostname:
```bash
sudo hostnamectl set-hostname mail.vwh.sh
```
4. Update `/etc/hosts`:
```bash
sudo nano /etc/hosts
```
Add: `[Your VPS IP] mail.vwh.sh vwh.sh`
---
### Step 3: Install and Configure Postfix
1. Install Postfix:
```bash
sudo apt install postfix -y
```
2. During installation, choose "Internet Site" and enter "vwh.sh" as the system mail name
3. Edit the main Postfix configuration:
```bash
sudo nano /etc/postfix/main.cf
```
Add or modify these lines:
```
myhostname = mail.vwh.sh
mydestination = $myhostname, vwh.sh, localhost.$mydomain, localhost
inet_interfaces = all
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
smtpd_recipient_restrictions = permit_mynetworks, reject_unauth_destination
virtual_alias_domains = vwh.sh
virtual_alias_maps = regexp:/etc/postfix/virtual_regexp
```
4. Create and edit the `virtual_regexp` file:
```bash
sudo nano /etc/postfix/virtual_regexp
```
Add this line:
```
/.+@vwh\.sh/ [email protected]
```
---
5. Restart Postfix:
```bash
sudo systemctl restart postfix
```
---
### Step 4: Configure Postfix to Forward Emails to Webhook
1. Install procmail:
```bash
sudo apt install procmail -y
```
2. Create a script to forward emails:
```bash
sudo nano /usr/local/bin/forward-to-webhook.sh
```
Add the following content:
```bash
#!/bin/bash
sed '/Content-Disposition: attachment/,/^\s*$/d; /Content-Disposition: inline/,/^\s*$/d' | \
curl -X POST -H "Content-Type: text/plain" -H "Secret: 12398" --data-binary @- http://localhost:9169/webhook
```
**Note**: Update the `Secret` to match your website/webhook environment variable
**Note**: It will forward the email to the webhook URL by default (http://localhost:9169/webhook). If you want to forward it to a different URL, you can change the URL in the script.
3. Make the script executable:
```bash
sudo chmod +x /usr/local/bin/forward-to-webhook.sh
```
4. Edit the Postfix aliases file:
```bash
sudo nano /etc/aliases
```
Add this line:
```
catchall: "|/usr/local/bin/forward-to-webhook.sh"
```
5. Update the aliases database:
```bash
sudo newaliases
```
6. Restart Postfix:
```bash
sudo systemctl restart postfix
```
---
### Step 5: Install and Configure Website
1. Clone VWH Email repository:
```bash
git clone https://github.com/vwh/vwh-email
cd vwh-email
```
2. Install dependencies:
```bash
npm install --force
```
3. Configure environment variables:
- Add your `SECRET` to the environment configuration
```bash
SECRET="12398"
```
4. Start development server:
```bash
npm run dev
```
---
## Contributing
Contributions are welcome! Feel free to open a pull request with your improvements or fixes.
## License
Under the MIT License. See [License](https://github.com/vwh/vwh-email/blob/main/LICENSE) for more information.