Wiki Release: 2026.09.8 · UltimateClans: 9.1.4 · Documentation branch: 9 · Mail

Mail#

Mail adds persistent clan mail/messages with send/read/unread state, GUI, storage and placeholders. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.

Compatibility#

Component version: 1.2
Documentation release: 2026.09.8
Minimum UltimateClans version: 9.0.0

What you can do with it#

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

How it works#

Clan mailbox model#

Mail stores clan messages with read/unread state and retention limits. max_storage, max_unread, character limits and expiry protect the mailbox from unlimited growth. Sending, reading and clearing are controlled separately by clan-role permissions.

First setup#

Before enabling the feature for players, review these installed files:

commands.yml
config.yml
gui.yml
language/Lang_EN.yml
language/Lang_ES.yml

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.

This feature is mainly automatic or accessed through the parent plugin/GUI, so it does not need a large standalone command tree.

GUI areas#

The installed GUI configuration contains screens/sections such as:

General.clan_mail
General.clear_mail_confirm
General.new_mail
General.anvil_new_mail

What administrators should configure#

Configure mailbox limits/expiry and storage before production.

Configuration map#

config.yml — Config (date_format_short, Mail, Icon, Permissions, logger); Storage (type, mysql, user, pass, databases, datasource)

The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.

Before going live#

Back up the component data/configuration.
Start the server and confirm the component is detected without startup errors.
Test with a non-OP player and the lowest clan role that should have access.
Exercise the complete flow once, including the failure/deny path, not only the happy path.
Restart the server and verify that persistent state survives.
If the network is multiserver, repeat the test from a second node and verify storage/synchronization.

Troubleshooting quick reference#

Symptom	Likely cause	What to check
Mail sends but recipient clan cannot see it	Target resolution/storage save failed or mailbox filter hides it	Check target clan and persisted mail record.
Unread count stays wrong	Read-state update/cache did not persist	Reopen mailbox and inspect storage errors.
Mail disappears early	Expiry/cleanup setting is too short	Review retention/expiry configuration.

For a longer diagnostic flow, open the Troubleshooting page for this component.