Mercurial > prosody-modules

view mod_admin_notify/README.markdown @ 5351:c35f3c1762b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_audit: Move underscore to avoid luacheck warning Underscore as prefix is taken as a signal that the variable is unused, but then it is used and luacheck makes noise about that.
author Kim Alvefur <zash@zash.se>
date Mon, 17 Apr 2023 08:26:20 +0200
parents e97c509fdbe3
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.