Difference between revisions of "Mail.php"
From Bebot Wiki 2
Jump to navigationJump to search (Created page with '====== Mail.php ====== ==== Description ==== This module allows members and guests to send messages that will be saved (for a configurable amount of time). ==== Features ====…') |
|||
| Line 14: | Line 14: | ||
===== Commands provided ===== | ===== Commands provided ===== | ||
| − | + | <pre> | |
^Command ^ Keyword ^Argument(s) ^Description ^Tell ^Guild ^Priv ^ | ^Command ^ Keyword ^Argument(s) ^Description ^Tell ^Guild ^Priv ^ | ||
|!mail | | |Shows the mailbox |Member |Member |Member | | |!mail | | |Shows the mailbox |Member |Member |Member | | ||
|!mail |send |<target> <msg>|Sends <msg> to <target> |Member |Member |Member | | |!mail |send |<target> <msg>|Sends <msg> to <target> |Member |Member |Member | | ||
| + | </pre> | ||
<sub> | <sub> | ||
| Line 26: | Line 27: | ||
===== Module settings ===== | ===== Module settings ===== | ||
| − | + | <pre> | |
^Setting ^Default ^Description ^ | ^Setting ^Default ^Description ^ | ||
|Max_life_read |6_months |How long does read mail stay in the mail-box | | |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 | | |Max_life_unread |1_year |How long does unread mail stay in the mail-box | | ||
| + | </pre> | ||
<sub> | <sub> | ||
| Line 37: | Line 39: | ||
===== Module preferences ===== | ===== Module preferences ===== | ||
| − | + | <pre> | |
^Preference ^Default ^Description ^ | ^Preference ^Default ^Description ^ | ||
|Life_read |1_month |How long does read mail stay in the mail-box | | |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 | | |Life_unread |6_months |How long does unread mail stay in the mail-box | | ||
| + | </pre> | ||
<sub> | <sub> | ||
Revision as of 09:00, 30 July 2021
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 |
Notes to table:\\
- Calls to mail in GC and PrivGroup will always return the mail list in a tell.
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 |
Notes to table:\\
- These limits are currently not enforced
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 |
Notes to table:\\
- These limits are currently not enforced
Notes
* This module requires core/BaseModule.php * This module requires code/Error.php * This module requires core/Preferences.php
