From 1c580ba787d68840d8b41d679fa56d4c53e539d3 Mon Sep 17 00:00:00 2001 From: Brandon Turner Date: Mon, 26 Aug 2013 14:08:40 -0500 Subject: [PATCH] Add help text for ns_goodmail module I wasn't sure how to contribute help files to the contrib repo. Feel free to delete this if it doesn't make sense. --- help/default/ns_goodmail | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 help/default/ns_goodmail diff --git a/help/default/ns_goodmail b/help/default/ns_goodmail new file mode 100644 index 0000000..7ecf150 --- /dev/null +++ b/help/default/ns_goodmail @@ -0,0 +1,35 @@ +Help for GOODMAIL: + +GOODMAIL allows you to maintain a whitelist of email addresses that +are allowed to be used to register accounts. Any email not on this +list will not be allowed to be registered. + +These email addresses are saved to the Atheme database and are kept +between services restarts. + +In GOODMAIL ADD, you are able to use glob matching to whitelist email +addresses that match a pattern. + +Syntax: GOODMAIL ADD [reason] + +Examples: + /msg &nick& GOODMAIL ADD jdhore1@gmail.com bar reason + /msg &nick& GOODMAIL ADD *@aol.com bar reason + /msg &nick& GOODMAIL ADD *@*.tk foo reason + +GOODMAIL DEL allows you to remove entries from the list of currently +whitelisted email addresses. + +Syntax: GOODMAIL DEL + +Examples: + /msg &nick& GOODMAIL DEL foo@bar.com + /msg &nick& GOODMAIL DEL *@aol.com + +GOODMAIL LIST allows you to list the currently whitelisted email +addresses. + +Syntax: GOODMAIL LIST + +Examples: + /msg &nick& GOODMAIL LIST