Wiki Release: 2026.09.5 · UltimateClans: 9.1.4 · Documentation branch: 9 · Mail
Mail configuration#
This reference is generated from the installed files supplied for this documentation release. Keep YAML indentation intact and back up files before large changes.
commands.yml#
| Path | Type | Default / sample value |
|---|---|---|
| Commands | section | |
| Commands.player | section | |
| Commands.player.permission | string | uclans.player.mail |
| Commands.player.alias | string | |
| Commands.player.cooldown | integer | 0 |
| Commands.player.value | number | 0.0 |
| Commands.player.disabled_worlds | list | |
| Commands.player.disabled_regions | list | |
| Commands.mail | section | |
| Commands.mail.help | section | |
| Commands.mail.help.aliases | string | help |
| Commands.mail.clear | section | |
| Commands.mail.clear.aliases | string | clear |
| Commands.mail.read | section | |
| Commands.mail.read.aliases | string | read |
| Commands.mail.send | section | |
| Commands.mail.send.aliases | string | send |
config.yml#
| Path | Type | Default / sample value |
|---|---|---|
| Config | section | |
| Config.date_format_short | string | dd/MM/yyyy |
| Config.Mail | section | |
| Config.Mail.enabled | boolean | True |
| Config.Mail.enable_colors | boolean | True |
| Config.Mail.enabled_for_all_clans | boolean | False |
| Config.Mail.time_expires | integer | 1440 |
| Config.Mail.max_storage | integer | 70 |
| Config.Mail.max_unread | integer | 14 |
| Config.Mail.max_chars | integer | 50 |
| Config.Mail.min_chars | integer | 1 |
| Config.Icon | section | |
| Config.Icon.click_sound | string | |
| Config.Icon.material | string | BOOKSHELF |
| Config.Icon.texture | string | |
| Config.Icon.glow | boolean | False |
| Config.Icon.slot | integer | 2 |
| Config.Icon.mimeslots | list | |
| Config.Icon.nbt | section | |
| Config.Icon.nbt.string | list | |
| Config.Icon.model | integer | 0 |
| Config.Icon.left_click_action | list | /{_clan} {_mail} {_read} -gui |
| Config.Icon.right_click_action | list | /{_clan} {_mail} {_read} -gui |
| Config.Permissions | section | |
| Config.Permissions.read | section | |
| Config.Permissions.read.name | string | Mail-Read |
| Config.Permissions.read.default_value | boolean | True |
| Config.Permissions.read.applicable_roles | list | member, moderator, admin |
| Config.Permissions.send | section | |
| Config.Permissions.send.name | string | Mail-Send |
| Config.Permissions.send.default_value | boolean | True |
| Config.Permissions.send.applicable_roles | list | member, moderator, admin |
| Config.Permissions.clear | section | |
| Config.Permissions.clear.name | string | Mail-Clear |
| Config.Permissions.clear.default_value | boolean | False |
| Config.Permissions.clear.applicable_roles | list | moderator, admin |
| Config.Permissions.edit | section | |
| Config.Permissions.edit.name | string | Mail-Edit |
| Config.Permissions.edit.default_value | boolean | False |
| Config.Permissions.edit.applicable_roles | list | moderator, admin |
| Config.logger | section | |
| Config.logger.enable_colors | boolean | True |
| Config.logger.plugin_material | string | BOOKSHELF |
| Config.logger.plugin_name | string | |
| Config.logger.events | section | |
| Config.logger.events.ClanBankAddEvent | boolean | True |
| Config.logger.events.ClanBankWithdrawEvent | boolean | True |
| Storage | section | |
| Storage.type | string | sqlite |
| Storage.mysql | section | |
| Storage.mysql.host | string | localhost |
| Storage.mysql.port | integer | 3306 |
| Storage.mysql.base | string | YOUR-BASE-PRE-CREATED |
| Storage.mysql.useSSL | boolean | False |
| Storage.user | string | root |
| Storage.pass | string | |
| Storage.databases | section | |
| Storage.databases.mail_table | string | uclans-mail |
| Storage.datasource | section | |
| Storage.datasource.mysql | string | jdbc:mysql:// |
| Storage.datasource.mysql_class | string | |
| Storage.datasource.sqlite | string | jdbc:sqlite: |
| Storage.datasource.sqlite_class | string | org.sqlite.JDBC |
gui.yml#
| Path | Type | Default / sample value |
|---|---|---|
| General | section | |
| General.clan_mail | section | |
| General.clan_mail.opensound | string | block.slime_block.hit |
| General.clan_mail.rows | integer | 6 |
| General.clan_mail.pagesize | integer | 35 |
| General.clan_mail.items | section | |
| General.clan_mail.items.fill | section | |
| General.clan_mail.items.fill.material | string | BLUE_STAINED_GLASS_PANE |
| General.clan_mail.items.fill.amount | integer | 1 |
| General.clan_mail.items.fill.glow | boolean | False |
| General.clan_mail.items.fill.enabled | boolean | True |
| General.clan_mail.items.fill.mimeslots | list | BOTTOM |
| General.clan_mail.items.fill.nbt | section | |
| General.clan_mail.items.fill.nbt.string | list | |
| General.clan_mail.items.fill.model | integer | 0 |
| General.clan_mail.items.fill2 | section | |
| General.clan_mail.items.fill2.material | string | BLUE_STAINED_GLASS_PANE |
| General.clan_mail.items.fill2.amount | integer | 1 |
| General.clan_mail.items.fill2.glow | boolean | False |
| General.clan_mail.items.fill2.enabled | boolean | True |
| General.clan_mail.items.fill2.mimeslots | list | 1, 10, 19, 27, … |
| General.clan_mail.items.fill2.nbt | section | |
| General.clan_mail.items.fill2.nbt.string | list | |
| General.clan_mail.items.fill2.model | integer | 0 |
| General.clan_mail.items.filter_all | section | |
| General.clan_mail.items.filter_all.clicksound | string | |
| General.clan_mail.items.filter_all.material | string | BOOKSHELF |
| General.clan_mail.items.filter_all.texture | string | |
| General.clan_mail.items.filter_all.data | integer | 0 |
| General.clan_mail.items.filter_all.amount | integer | 1 |
| General.clan_mail.items.filter_all.glow | boolean | False |
| General.clan_mail.items.filter_all.slot | integer | 0 |
| General.clan_mail.items.filter_all_current | section | |
| General.clan_mail.items.filter_all_current.clicksound | string | |
| General.clan_mail.items.filter_all_current.material | string | RED_STAINED_GLASS_PANE |
| General.clan_mail.items.filter_all_current.texture | string | |
| General.clan_mail.items.filter_all_current.data | integer | 0 |
| General.clan_mail.items.filter_all_current.amount | integer | 1 |
| General.clan_mail.items.filter_all_current.glow | boolean | True |
| General.clan_mail.items.filter_all_current.slot | integer | 0 |
| General.clan_mail.items.filter_unread | section | |
| General.clan_mail.items.filter_unread.clicksound | string | |
| General.clan_mail.items.filter_unread.material | string | WRITABLE_BOOK |
| General.clan_mail.items.filter_unread.texture | string | |
| General.clan_mail.items.filter_unread.data | integer | 0 |
| General.clan_mail.items.filter_unread.amount | integer | 1 |
| General.clan_mail.items.filter_unread.glow | boolean | False |
| General.clan_mail.items.filter_unread.slot | integer | 9 |
| General.clan_mail.items.filter_unread_current | section | |
| General.clan_mail.items.filter_unread_current.clicksound | string | |
| General.clan_mail.items.filter_unread_current.material | string | RED_STAINED_GLASS_PANE |
| General.clan_mail.items.filter_unread_current.texture | string | |
| General.clan_mail.items.filter_unread_current.data | integer | 0 |
| General.clan_mail.items.filter_unread_current.amount | integer | 1 |
| General.clan_mail.items.filter_unread_current.glow | boolean | True |
| General.clan_mail.items.filter_unread_current.slot | integer | 9 |
| General.clan_mail.items.filter_read | section | |
| General.clan_mail.items.filter_read.clicksound | string | |
| General.clan_mail.items.filter_read.material | string | BOOK |
| General.clan_mail.items.filter_read.texture | string | |
| General.clan_mail.items.filter_read.data | integer | 0 |
| General.clan_mail.items.filter_read.amount | integer | 1 |
| General.clan_mail.items.filter_read.glow | boolean | False |
| General.clan_mail.items.filter_read.slot | integer | 18 |
| General.clan_mail.items.filter_read_current | section | |
| General.clan_mail.items.filter_read_current.clicksound | string | |
| General.clan_mail.items.filter_read_current.material | string | RED_STAINED_GLASS_PANE |
| General.clan_mail.items.filter_read_current.texture | string | |
| General.clan_mail.items.filter_read_current.data | integer | 0 |
| General.clan_mail.items.filter_read_current.amount | integer | 1 |
| General.clan_mail.items.filter_read_current.glow | boolean | True |
| General.clan_mail.items.filter_read_current.slot | integer | 18 |
| General.clan_mail.items.new | section | |
| General.clan_mail.items.new.clicksound | string | |
| General.clan_mail.items.new.material | string | FEATHER |
| General.clan_mail.items.new.texture | string | |
| General.clan_mail.items.new.data | integer | 0 |
| General.clan_mail.items.new.amount | integer | 1 |
| General.clan_mail.items.new.glow | boolean | True |
| General.clan_mail.items.new.slot | integer | 45 |
| General.clan_mail.items.clear | section | |
| General.clan_mail.items.clear.clicksound | string | |
| General.clan_mail.items.clear.material | string | BARRIER |
| General.clan_mail.items.clear.texture | string | |
| General.clan_mail.items.clear.data | integer | 0 |
| General.clan_mail.items.clear.amount | integer | 1 |
| General.clan_mail.items.clear.glow | boolean | True |
| General.clan_mail.items.clear.slot | integer | 53 |
| General.clan_mail.items.previous | section | |
| General.clan_mail.items.previous.clicksound | string | |
| General.clan_mail.items.previous.material | string | ARROW |
| General.clan_mail.items.previous.texture | string | |
| General.clan_mail.items.previous.amount | integer | 1 |
| General.clan_mail.items.previous.glow | boolean | False |
| General.clan_mail.items.previous.slot | integer | 47 |
| General.clan_mail.items.next | section | |
| General.clan_mail.items.next.clicksound | string | |
| General.clan_mail.items.next.material | string | ARROW |
| General.clan_mail.items.next.texture | string | |
| General.clan_mail.items.next.amount | integer | 1 |
| General.clan_mail.items.next.glow | boolean | False |
| General.clan_mail.items.next.slot | integer | 51 |
| General.clan_mail.items.current | section | |
| General.clan_mail.items.current.clicksound | string | |
| General.clan_mail.items.current.material | string | PAPER |
| General.clan_mail.items.current.texture | string | |
| General.clan_mail.items.current.data | integer | 0 |
| General.clan_mail.items.current.amount | integer | 1 |
| General.clan_mail.items.current.glow | boolean | True |
| General.clan_mail.items.back | section | |
| General.clan_mail.items.back.clicksound | string | |
| General.clan_mail.items.back.material | string | IRON_DOOR |
| General.clan_mail.items.back.texture | string | |
| General.clan_mail.items.back.data | integer | 0 |
| General.clan_mail.items.back.amount | integer | 1 |
| General.clan_mail.items.back.glow | boolean | True |
| General.clan_mail.items.back.slot | integer | 49 |
| General.clear_mail_confirm | section | |
| General.clear_mail_confirm.opensound | string | block.slime_block.hit |
| General.clear_mail_confirm.rows | integer | 3 |
| General.clear_mail_confirm.items | section | |
| General.clear_mail_confirm.items.fill | section | |
| General.clear_mail_confirm.items.fill.material | string | RED_STAINED_GLASS_PANE |
| General.clear_mail_confirm.items.fill.amount | integer | 1 |
| General.clear_mail_confirm.items.fill.glow | boolean | False |
| General.clear_mail_confirm.items.fill.mimeslots | list | ALL |
| General.clear_mail_confirm.items.confirm | section | |
| General.clear_mail_confirm.items.confirm.clicksound | string | |
| General.clear_mail_confirm.items.confirm.material | string | DIAMOND_BLOCK |
| General.clear_mail_confirm.items.confirm.amount | integer | 1 |
| General.clear_mail_confirm.items.confirm.glow | boolean | True |
| General.clear_mail_confirm.items.confirm.slot | integer | 10 |
| General.clear_mail_confirm.items.confirm.mimeslots | list | 11, 12 |
| General.clear_mail_confirm.items.cancel | section | |
| General.clear_mail_confirm.items.cancel.clicksound | string | |
| General.clear_mail_confirm.items.cancel.material | string | REDSTONE_BLOCK |
| General.clear_mail_confirm.items.cancel.amount | integer | 1 |
| General.clear_mail_confirm.items.cancel.glow | boolean | True |
| General.clear_mail_confirm.items.cancel.texture | string | |
| General.clear_mail_confirm.items.cancel.slot | integer | 14 |
| General.clear_mail_confirm.items.cancel.mimeslots | list | 15, 16 |
| General.new_mail | section | |
| General.new_mail.opensound | string | block.slime_block.hit |
| General.new_mail.rows | integer | 6 |
| General.new_mail.pagesize | integer | 27 |
| General.new_mail.items | section | |
| General.new_mail.items.fill | section | |
| General.new_mail.items.fill.material | string | BLUE_STAINED_GLASS_PANE |
| General.new_mail.items.fill.amount | integer | 1 |
| General.new_mail.items.fill.glow | boolean | False |
| General.new_mail.items.fill.mimeslots | list | 0, 1, 2, 3, … |
| General.new_mail.items.fill2 | section | |
| General.new_mail.items.fill2.material | string | BLUE_STAINED_GLASS_PANE |
| General.new_mail.items.fill2.amount | integer | 1 |
| General.new_mail.items.fill2.glow | boolean | False |
| General.new_mail.items.fill2.mimeslots | list | BOTTOM |
| General.new_mail.items.my | section | |
| General.new_mail.items.my.clicksound | string | |
| General.new_mail.items.my.material | string | |
| General.new_mail.items.my.texture | string | %uclans_banner% |
| General.new_mail.items.my.amount | integer | 1 |
| General.new_mail.items.my.glow | boolean | True |
| General.new_mail.items.my.slot | integer | 4 |
| General.new_mail.items.current | section | |
| General.new_mail.items.current.clicksound | string | |
| General.new_mail.items.current.material | string | |
| General.new_mail.items.current.texture | string | %uclans_banner% |
| General.new_mail.items.current.amount | integer | 1 |
| General.new_mail.items.current.glow | boolean | True |
| General.new_mail.items.previous | section | |
| General.new_mail.items.previous.clicksound | string | |
| General.new_mail.items.previous.material | string | ARROW |
| General.new_mail.items.previous.texture | string | |
| General.new_mail.items.previous.amount | integer | 1 |
| General.new_mail.items.previous.glow | boolean | False |
| General.new_mail.items.previous.slot | integer | 47 |
| General.new_mail.items.next | section | |
| General.new_mail.items.next.clicksound | string | |
| General.new_mail.items.next.material | string | ARROW |
| General.new_mail.items.next.texture | string | |
| General.new_mail.items.next.amount | integer | 1 |
| General.new_mail.items.next.glow | boolean | False |
| General.new_mail.items.next.slot | integer | 51 |
| General.new_mail.items.back | section | |
| General.new_mail.items.back.clicksound | string | |
| General.new_mail.items.back.material | string | IRON_DOOR |
| General.new_mail.items.back.amount | integer | 1 |
| General.new_mail.items.back.glow | boolean | True |
| General.new_mail.items.back.texture | string | |
| General.new_mail.items.back.slot | integer | 49 |
| General.anvil_new_mail | section | |
| General.anvil_new_mail.opensound | string | block.slime_block.hit |
| General.anvil_new_mail.items | section | |
| General.anvil_new_mail.items.left | section | |
| General.anvil_new_mail.items.left.clicksound | string | |
| General.anvil_new_mail.items.left.material | string | PAPER |
| General.anvil_new_mail.items.left.texture | string | |
| General.anvil_new_mail.items.left.amount | integer | 1 |
| General.anvil_new_mail.items.left.glow | boolean | True |
| General.anvil_new_mail.items.right | section | |
| General.anvil_new_mail.items.right.clicksound | string | |
| General.anvil_new_mail.items.right.material | string | IRON_DOOR |
| General.anvil_new_mail.items.right.texture | string | |
| General.anvil_new_mail.items.right.amount | integer | 1 |
| General.anvil_new_mail.items.right.glow | boolean | True |
| General.anvil_new_mail.items.output | section | |
| General.anvil_new_mail.items.output.clicksound | string | |
| General.anvil_new_mail.items.output.material | string | |
| General.anvil_new_mail.items.output.texture | string | %uclans_banner% |
| General.anvil_new_mail.items.output.amount | integer | 1 |
| General.anvil_new_mail.items.output.glow | boolean | True |
language/Lang_EN.yml#
Language file. Messages are editable; keep placeholders and MiniMessage/legacy formatting tokens intact. The exact file is included in TicketAI technical knowledge.
language/Lang_ES.yml#
Language file. Messages are editable; keep placeholders and MiniMessage/legacy formatting tokens intact. The exact file is included in TicketAI technical knowledge.