Mercurial > prosody-modules

comparison mod_admin_notify/README.markdown @ 4238:e97c509fdbe3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_admin_notify: New module providing an API to notify host admins
author Matthew Wild <mwild1@gmail.com>
date Mon, 09 Nov 2020 16:53:13 +0000
parents
children
comparison
equal deleted inserted replaced
4237:a0ab7be0538d 4238:e97c509fdbe3
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: API to notify server admins
5 ---
6
7 # Introduction
8
9 This module provides an API for other module developers to send
10 notification messages to host admins.
11
12 # Configuration
13
14 None required.
15
16 # Developers
17
18 Example:
19
20 ```
21 local notify_admins = module:depends("admin_notify").notify;
22
23 notify("This is an important message for you, admins")
24 ```
25
26 # Compatibility
27
28 Prosody trunk or later. Incompatible with 0.11 or lower.