Mercurial > prosody-modules
diff mod_admin_notify/README.markdown @ 4238:e97c509fdbe3
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 (2020-11-09) |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_admin_notify/README.markdown Mon Nov 09 16:53:13 2020 +0000 @@ -0,0 +1,28 @@ +--- +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.