File

mod_admin_notify/README.md @ 6146:dde2803f7678

mod_persisthosts: Retrieve hosts from config instead of Prosody state This should avoid missing hosts that are activated after the one this module was loaded from.
author Kim Alvefur <zash@zash.se>
date Fri, 10 Jan 2025 16:19:27 +0100
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.