Mercurial > prosody-modules

view mod_admin_notify/README.markdown @ 5755:4a353ccce220

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
luacheckrc: Replace deprecated module:once with :on_ready So that :once is warned about properly. module:once was only added in trunk so it shouldn't have gotten very far yet.
author Kim Alvefur <zash@zash.se>
date Sat, 02 Dec 2023 11:10:43 +0100
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.