Item expiry
Unclaimed items expire after a set number of days, with warnings before they go.
Items left in a mailbox do not sit there forever. After a set number of days they expire and are removed. Players are warned before that happens, so they have a chance to claim them.
How expiry works
- Each stored item has an expiry time, set when it lands in the mailbox.
- Expired items are purged on player join and on an hourly task.
- Players can be warned when an item is close to expiring.
Settings
| Setting | Default | What it does |
|---|---|---|
mailbox.expiry.enabled | true | Turns expiry on or off. |
mailbox.expiry.days | 7 | Days an item may sit before it expires. |
mailbox.expiry.warn-before-days | 1 | Warn when an item has this many days left or fewer. |
mailbox.expiry.warn-on-join | true | Send a warning when the player logs in. |
mailbox.expiry.warn-periodic | true | Warn online players from time to time. |
mailbox.expiry.warn-period-minutes | 60 | Minutes between periodic warnings. |
Items close to expiry also show a "time left" note in their lore inside the GUI, so players can see at a glance which ones to grab first.
Turning expiry off
Set mailbox.expiry.enabled to false if you want items to stay until claimed. The
warning settings then have no effect.
With expiry off, mailboxes can fill up and stay full. Plan your capacity tiers so active players do not hit the limit. See Capacity tiers.
Related pages
- The mailbox GUI shows the expiry note on items.
- Messages and language covers the warning text.