File

mod_admin_notify/README.md @ 6143:61422d3c60fb

mod_cloud_notify: Prevent loading if Prosody indicates it is already bundled This ensures the bundled version will always be preferred.
author Matthew Wild <mwild1@gmail.com>
date Thu, 09 Jan 2025 15:57:19 +0000
parent 6003:fe081789f7b5
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: API to notify server admins
---

# Introduction

This module provides an API for other module developers to send
notification messages to host admins.

# Configuration

None required.

# Developers

Example:

```
local notify_admins = module:depends("admin_notify").notify;

notify("This is an important message for you, admins")
```

# Compatibility

Prosody trunk or later. Incompatible with 0.11 or lower.