cadey
/
emehta-contrib
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Brandon Turner 2013-08-26 14:08:40 -05:00
parent 4753339580
commit 1c580ba787
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
help/default/ns_goodmail Normal file
View File

@ -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 <email> [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 <email>
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