view mod_throttle_unsolicited/README.markdown @ 2323:35ae59a8196d

Add some documentation stubs
author Kim Alvefur <zash@zash.se>
date Sat, 01 Oct 2016 20:34:43 +0200
parents 163d55777ad5
children 1424aa8877f0
line wrap: on
line source

---
depends:
- 'mod\_track\_muc\_joins'
summary: Limit rate of outgoing unsolicited messages
...

Introduction
============

This module limits the rate of outgoing unsolicited messages. A message
counts as "unsolicited" if the receiving user hasn't added the sending
user to their roster.

The module depends on [mod\_track\_muc\_joins] in order to allow sent
messages to joined MUC rooms.

Configuration
=============

``` {.lua}
unsolicited_messages_per_minute = 10
```