# HG changeset patch
# User jeffrey.mitchell
# Date 1252616454 0
# Node ID 8621fd125d84c224b4972cdc16f2d8b7900d3bb5
# Parent  24d055fb593605911aedea43a6c466a290eae74b
Created wiki page through web user interface.

diff -r 24d055fb5936 -r 8621fd125d84 mod_onhold.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_onhold.wiki	Thu Sep 10 21:00:54 2009 +0000
@@ -0,0 +1,16 @@
+#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.
\ No newline at end of file