Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · Mail
Mail practical usage guide#
Mail adds persistent clan mail/messages with send/read/unread state, GUI, storage and placeholders. This guide focuses on the actual administrator and player workflow: what to set up first, how to test it in-game, and what to check before enabling it for everyone.
How the feature works#
In normal use, the feature follows this flow: Send a test clan mail using the configured command/GUI. Open the mailbox, read the message and verify unread state changes. Use clear/delete management according to your retention policy.
Recommended in-game workflow#
- Send a test clan mail using the configured command/GUI.
- Open the mailbox, read the message and verify unread state changes.
- Use clear/delete management according to your retention policy.
Administrator setup checklist#
- Configure mailbox limits/expiry and storage before production.
Configuration areas#
Config—date_format_short,Mail,Icon,Permissions,loggerStorage—type,mysql,user,pass,databases,datasource
Changing settings safely#
- Back up the component configuration and persistent data before changing a live server.
- Change one feature area at a time.
- Reload only if the component documents reload as safe; otherwise restart the server.
- Test with a non-OP account that has exactly the intended clan role/permission.
- Watch the console from the first relevant warning/error, not only the final stack trace.
- On multiserver networks, repeat the check on every node and confirm shared storage/sync settings match.