Mercurial > prosody-modules

view mod_admin_notify/README.markdown @ 4615:451514e2d369

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_pep_avatar: Fix name of module in example README was copied from mod_http_avatar, probably forgot to update that.
author Kim Alvefur <zash@zash.se>
date Tue, 06 Jul 2021 21:12:56 +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.