Mailbox
Rewards that cannot be given right away wait safely in the mailbox until the player can receive them.
The mailbox makes sure nothing a player earns is ever dropped on the ground or lost. When a reward cannot be given right away, because the inventory is full, the player is offline or the player is on another server of your network, it waits in the player's mailbox.
The mailbox is always on. It works on its own, and other modules use it automatically.
How delivery works
- Inventory full: the items that fit are given, the rest goes to the mailbox and the player is told: Inventory full. Your rewards wait in /mailbox.
- At join: waiting rewards are given automatically a few seconds after the player joins, so that synced inventories and balances are ready first. You can change this delay with Delay after joining in the mailbox settings (3 seconds by default).
- On another server: deliveries are shared by the whole network. A reward earned on one server reaches the player on the server they are playing on.
- Exactly once: a delivery can only be claimed once across the whole network, even if the server crashes during the delivery.
A delivery can hold items, money and commands. Money is added to the player's balance, and commands run when the delivery is claimed. Items that still do not fit stay in the mailbox for later.
The /mailbox command
| Command | What it does |
|---|---|
/mailbox |
Opens the mailbox menu, or lists the waiting deliveries in the chat if you chose chat mode. |
/mailbox claim |
Claims every waiting delivery. |
/mailbox claim <number> |
Claims one delivery, by its number in the chat list. |
Alias: /mbox. Permission: inglis.mailbox.mailbox, given to everyone by default.
In the menu, each waiting delivery is shown with its content. Click one to claim it, or click Claim everything at the bottom. Large mailboxes are split into pages.
The command uses the shared command rules: from the Command tab of the mailbox page in the web editor you can rename it, add aliases, change its permission, switch between menu and chat, disable it in some worlds, and set a cooldown or price per rank.
Managing a player's mailbox
Open a player's profile from Players in the web editor to see their waiting deliveries, with the content and date of each one.
- Give now delivers it to the player immediately. The player must be online.
- Delete removes it without giving it to the player.
Modules that use the mailbox
| Module | What can land in the mailbox |
|---|---|
| Auction | Purchases, sale earnings, won auctions, refunded bids, expired, cancelled or removed listings |
| Battle pass | Tier rewards, free and premium |
| Crates | Crate rewards |
| Discord | The reward for linking a Discord account |
| Kits | Kit items that do not fit |
| Leaderboards | Rewards for leaderboard positions |
| Rewards | Daily rewards and playtime rewards |
Each delivery is labelled with where it comes from, for example Crate vote or Battle pass, tier 5, in the language of the player who reads it.
The mailbox texts (menu title, messages, labels) can be rewritten on the Messages page, under Mailbox. See languages.