Continuing the legacy of Vanced

✉️ ReVanced Cloudflare Email Worker

A Cloudflare Email Worker to reply to or filter mails

❓ About

With ReVanced Cloudflare Email Worker, spam can be mitigated by enforcing a policy for incoming emails. Senders are asked to include a secret in the email, which can be found in the policy.

💪 Features

• 📧 Auto-replies: Automatically reply to incoming emails
• ➡️ Email forwarding: Forward emails to a specified address
• ⚙️ Customizable: Customize sender information and message content for replies

🚀 How to get started

To get started with ReVanced Cloudflare Email Worker, pnpm is recommended, but npm can also be used. Follow the steps below to get started with ReVanced Cloudflare Email Worker:

1. Run git clone git@github.com:ReVanced/revanced-cloudflare-email-worker.git && cd revanced-cloudflare-email-worker to clone the repository
2. Run pnpm install to install dependencies
3. Set the environment variables and secrets from .env.example via the Cloudflare Workers dashboard according to this
4. Run pnpm deploy to deploy the project

📚 Everything else

📙 Contributing

Thank you for considering contributing to ReVanced Cloudflare Email Worker. You can find the contribution guidelines here.

🛠️ Building

To build ReVanced Cloudflare Email Worker, pnpm is recommended, but npm can also be used. Follow the steps below to build ReVanced Cloudflare Email Worker:

1. Run git clone git@github.com:ReVanced/revanced-cloudflare-email-worker.git && cd revanced-cloudflare-email-worker to clone the repository
2. Run pnpm install to install dependencies
3. Copy .env.example to .env and fill in the required values
4. Run pnpm types to generate types
5. Run pnpm dev to build and start the worker

📜 License

ReVanced Cloudflare Email Worker is licensed under the AGPLv3 licence. Please see the license file for more information. tl;dr you may copy, distribute and modify ReVanced Cloudflare Email Worker as long as you track changes/dates in source files. Any modifications to ReVanced Cloudflare Email Worker must also be made available under the GPL along with build & install instructions.