view mod_block_outgoing/README.markdown @ 2400:bd3a1df128a4

Add documentation for mod_block_outgoing
author Michael Vetter <jubalh@openmailbox.org>
date Sat, 26 Nov 2016 00:34:05 +0100
parents
children 34fb3d239ac1
line wrap: on
line source

---
summary: 'Block outgoing stanzas from users'
...

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

This module blocks all outgoing stanzas from a list of users.

Using
=====

Add mod_block_outgoing to the enabled modules in your config file:
``` {.lua}
modules_enabled = {
	-- ...
		"block_outgoing",
	-- ...
}
```

Either in a section for a certain host or the global section define which users and what stanzas to block:
``` {.lua}
block_outgoing_users = { "romeo@example.com", "juliet@example.com" }
block_outgoing_stanzas = { "message", "iq", "presence" }
```

block_outgoing_stanzas defaults to "message" if not specified.