view mod_admin_notify/README.markdown @ 4318:3dd7840cb923

mod_client_proxy: Fix typo in readme Thanks, @mdosch.
author Jonas Schäfer <jonas@wielicki.name>
date Tue, 05 Jan 2021 20:51:23 +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.