Difference between revisions of "Mail.php"

From Bebot Wiki 2
Jump to navigationJump to search
Line 43: Line 43:
 
|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          |
 +
|Logon_notification|Yes  |Do you want to be notified about new mail when you log on|
 
</pre>
 
</pre>
  

Revision as of 18:32, 21 September 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           |
|Logon_notification|Yes   |Do you want to be notified about new mail when you log on|

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