diff --git a/README.md b/README.md index c6a20f1..ebc96c4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # πŸ“¬ 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/ └── emails/ -└── example.com/ -└── alice/ -β”œβ”€β”€ 65ef123e4c1a0.eml -β”œβ”€β”€ index.php # optional -└── index.sh # optional + └── example.com/ + └── alice/ + β”œβ”€β”€ 65ef123e4c1a0.eml + β”œβ”€β”€ index.php # optional + └── index.sh # optional --- @@ -75,11 +76,11 @@ You can test the webhook manually via CLI: ```bash 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: β€’ index.sh: a shell script that reads from stdin