An open API service indexing awesome lists of open source software.

https://github.com/gutenye/email-notification

An elegant email notification service
https://github.com/gutenye/email-notification

cloudflare-workers email-notification jellyfin komodo ntfy self-hosted selfhost service simple

Last synced: about 1 month ago
JSON representation

An elegant email notification service

Awesome Lists containing this project

README

          

# πŸ’Œ Guten Email Notification πŸ’Œ

**An elegant email notification service**: Zero configuration, ntfy-like, supports popular apps out of the box, including: Jellyfin, Komodo, and more.

**Show your ❀️ and support by starring this project and following the author, [Guten Ye](https://github.com/gutenye)!**

[![Stars](https://img.shields.io/github/stars/gutenye/email-notification?style=social)](https://github.com/gutenye/email-notification)
[![License](https://img.shields.io/github/license/gutenye/email-notification?color=blue)](https://github.com/gutenye/email-notification/blob/main/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)](https://github.com/gutenye/email-notification#-contribute)
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
[![Cloudflare Workers](https://img.shields.io/badge/Cloudflare-Workers-F38020?logo=cloudflare&logoColor=white)](https://workers.cloudflare.com/)

## 🌠️ Screenshots

![Screenshot](./docs/screenshot.png)

## ✨ The Most Elegant Way to Send Email Notifications

```sh
curl NOTIFICATION_URL -d 'Title\nBody'
```

That’s your email β€” delivered.

βœ… Just a single HTTP request

βœ… First line β†’ your title

βœ… Next line β†’ your body

βœ… That’s it

**Perfect for:** Deployment complete, Server alert, Backup finished, Github Actions, Shell script, Self-hosted apps, NAS systems, monitoring tools, CI/CD pipelines

## 🌟 Features

- **Email Notifications**: Keep your notification history in your email inbox - never lose important alerts
- **Simple to use**: REST API with just a title and body - simple and elegant
- **Zero configuration**: Deploy once, works everywhere - just add url and start sending
- **Custom Templates**: Write templates in JavaScript - no more Handlebars or Go templates needed
- **Universal App Support**: Get notified from everything on your NAS - Jellyfin, Komodo, and 20+ more apps
- **Human-friendly messages**: Clean, readable notifications that anyone can understand
- **Free & Unlimited Emails**: Send as many notifications as you want, no limits, no hidden fees

## πŸ“– Documentation

- [Send Messages](./docs/SendMessages.md): API usage, examples, and advanced features
- [Quick Deploy](./docs/Deployment.md): One-click deployment to Cloudflare Workers
- [Supported Apps](./src/templates/Apps.md): Pre-built templates for popular apps
- [Development](./docs/Development.md): Local setup and development guide

## 🀝 Contributing

We love contributions! Whether you're fixing bugs, adding features, or improving documentation, your involvement makes this project better.

**How to Contribute:**

1. **Fork** the Repository
2. **Make** your changes (bug fixes, features, docs)
3. **Test** your changes thoroughly
4. **Open** a Pull Request on GitHub

**Looking for ideas?** Check out our [issues](https://github.com/gutenye/email-notification/issues) for bugs and feature requests!

---

Thank you for using Guten Email Notification! If you found it helpful, please ⭐️ **star the project** ⭐ on GitHub.

**Need help?** Check our [documentation](#-documentation) or [report an issue](https://github.com/gutenye/email-notification/issues) if you encounter any problems.

**Special Thanks to All Contributors:**

[![Contributors](https://contrib.rocks/image?repo=gutenye/email-notification)](https://github.com/gutenye/email-notification/graphs/contributors)

---


⬆ Back to top ⬆


Made with ❀️ by Guten Ye