mail.php

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

mail.php [2013/09/12 22:49]
mail.php [2020/09/12 01:30] (current)
Line 1: Line 1:
 +====== Mail.php ======
 +
 +==== Description ====
 +
 +This module allows members and guests to send messages that will be saved (for a configurable amount of time).
 +
 +
 +==== Features ====
 +
 +  * Allows asynchroneous communication between bot members
 +  * Mail is delivered to any registered alt
 +  * Item links remain clickable in messages
 +
 +
 +===== Commands provided =====
 +
 +^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
 +|!mail    |          |              |Shows the mailbox                    |Member    |Member    |Member    |
 +|!mail    |send      |<target> <msg>|Sends <msg> to <target>              |Member    |Member    |Member    |
 +
 +<sub>
 +Notes to table:\\
 + - Calls to mail in GC and PrivGroup will always return the mail list in a tell.
 +</sub>
 +
 +
 +===== Module settings =====
 +
 +^Setting         ^Default   ^Description                                              ^
 +|Max_life_read   |6_months  |How long does read mail stay in the mail-box             |
 +|Max_life_unread |1_year    |How long does unread mail stay in the mail-box           |
 +
 +<sub>
 +Notes to table:\\
 + - These limits are currently not enforced
 +</sub>
 +
 +===== Module preferences =====
 +
 +^Preference    ^Default   ^Description                                              ^
 +|Life_read     |1_month   |How long does read mail stay in the mail-box             |
 +|Life_unread   |6_months  |How long does unread mail stay in the mail-box           |
 +
 +<sub>
 +Notes to table:\\
 + - These limits are currently not enforced
 +</sub>
 +
 +
 +===== Notes =====
 +
 +  * This module requires core/BaseModule.php
 +  * This module requires code/Error.php
 +  * This module requires core/Preferences.php