Mercurial > prosody-wiki

annotate mod_onhold.wiki @ 359:9993b7c47dd0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Created wiki page through web user interface.
author MWild1@gmail.com
date Thu, 06 Jun 2013 18:05:54 +0000
parents 8621fd125d84
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
1 #summary Module enabling "on-hold" functionality
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
2
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
3 = Introduction =
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
4
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
5 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.
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
6
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
7
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
8 = Details =
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
9
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
10 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).
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
11
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
12 Simply enable mod_onhold in your list of modules, and then add a line:
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
13
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
14 onhold_jids = { "someone@address.com", "someoneelse@address2.com" }
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
15
8621fd125d84 Created wiki page through web user interface.
jeffrey.mitchell
parents:
diff changeset
16 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.