File

mod_onhold/README.markdown @ 5931:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parent 1803:4d73a1a6ba68
line wrap: on
line source

---
labels:
summary: 'Module enabling "on-hold" functionality'
...

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

Enable mod\_onhold to allow temporarily placing messages from particular
JIDs "on hold" -- i.e. store them, but do not deliver them until the
hold status is taken away.

Details
=======

Right now, it is configured through adding JIDs to a list in
prosody.cfg.lua. Eventually, more dynamically configurable support will
be added (i.e. with ad-hoc commands or some such thing).

Simply enable mod\_onhold in your list of modules, and then add a line:

onhold\_jids = { "someone@address.com", "someoneelse@address2.com" }

Until those JIDs are removed, messages from those JIDs will not be
delivered. Once they are removed and prosody is restarted, they will be
delivered the next time the user to which they are directed logs on.