improving accuracy of README.md
This commit is contained in:
parent
7382527340
commit
df26b1a859
17
README.md
17
README.md
@ -1,6 +1,7 @@
|
|||||||
# 📬 Email Webhook Receiver for ForwardEmail.net
|
# 📬 Email Webhook Receiver for ForwardEmail.net
|
||||||
|
|
||||||
This is a simple PHP webhook endpoint designed to receive incoming emails from [ForwardEmail.net](https://forwardemail.net). The script stores the raw email (`.eml`) files in a structured folder hierarchy and optionally triggers processing scripts per sender.
|
This is a simple PHP webhook endpoint designed to receive incoming emails from [ForwardEmail.net](https://forwardemail.net).
|
||||||
|
The script stores the raw email (`.eml`) files in a structured folder hierarchy and optionally triggers processing scripts per sender.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -19,11 +20,11 @@ This is a simple PHP webhook endpoint designed to receive incoming emails from [
|
|||||||
|
|
||||||
data/
|
data/
|
||||||
└── emails/
|
└── emails/
|
||||||
└── example.com/
|
└── example.com/
|
||||||
└── alice/
|
└── alice/
|
||||||
├── 65ef123e4c1a0.eml
|
├── 65ef123e4c1a0.eml
|
||||||
├── index.php # optional
|
├── index.php # optional
|
||||||
└── index.sh # optional
|
└── index.sh # optional
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -75,11 +76,11 @@ You can test the webhook manually via CLI:
|
|||||||
```bash
|
```bash
|
||||||
php index.php < sample.json
|
php index.php < sample.json
|
||||||
```
|
```
|
||||||
Where sample.json contains a raw test email in JSON format.
|
Where sample.json contains a raw test email in JSON format (in ForwardEmail.net format).
|
||||||
|
|
||||||
⸻
|
⸻
|
||||||
|
|
||||||
🛠️ Optional Per-Sender Automation
|
🛠️ [Optional] AUTO-PROCESSING emails (per-sender)
|
||||||
|
|
||||||
To auto-process incoming emails, create either:
|
To auto-process incoming emails, create either:
|
||||||
• index.sh: a shell script that reads from stdin
|
• index.sh: a shell script that reads from stdin
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user