Mercurial > prosody-modules

view mod_admin_notify/README.md @ 6140:62cd65205c70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_storage_metronome_readonly: Fix documentation for pep_data (was pep)
author Link Mauve <linkmauve@linkmauve.fr>
date Mon, 27 Jan 2025 21:32:08 +0100
parents fe081789f7b5
children
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.