Mailboxes

Real in-game output from Mailboxes 1.5.2 on a local throwaway Paper 1.21.11 test server: the commands were typed by a scripted bot client, and the chat it received is drawn as Minecraft-style chat (typed commands appear in the input bars; grey lines say what happened between commands).

Description

Mailboxes is an open source plugin that allows players and plugins to send persistent messages to players. Players can also attach items to their messages, making it easy to transfer items securely through in-game mail.

Supported Minecraft Versions

This plugin is supported on the Minecraft versions listed in minecraft-versions.json: currently 1.19.4, 1.21.11, 26.2 and 26.3 (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and every build checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up.

Features

• Persistent Messaging: Send messages that persist across server restarts
• Item Attachments: Attach items to messages for secure item transfer
• Configurable Limits: Server admins can configure attachment limits
• Permission-Based: Control who can use attachment features
• API Support: External plugins can integrate with Mailboxes

For more information about the item attachments feature, see ATTACHMENTS.md.

For Plugin Developers

Want to integrate Mailboxes into your plugin? Get started in minutes!

• Quick Start Guide - Send your first message in 5 minutes
• Complete API Documentation - Full API reference with examples

Key Features for Developers

• Simple API - send messages with just a few lines of code
• Support for online and offline players
• Messages persist across server restarts
• No complex setup required

Server Software

This plugin was developed using the Spigot API. Users may run into trouble using it with other available server softwares like Paper.

Installation

1. You can download the plugin from this page.

2. Once downloaded, place the jar in the plugins folder of your server files.

3. Restart your server.

Works Well With

Mailboxes is part of the medieval roleplay set of Dan's Plugins. These plugins suit the same kind of server and run side by side. Medieval Factions uses Mailboxes when it is present (see below); the others are companions that do not call into Mailboxes.

• Medieval Roleplay Engine (SpigotMC, /dpm get medievalroleplayengine): character cards, local, global, whisper and yell chat, emotes, dice and messenger birds.
• Medieval Factions (SpigotMC, /dpm get medievalfactions): nation-like factions with land claims, diplomacy and laws. When Mailboxes is installed, Medieval Factions delivers its faction notifications through it.
• Medieval Economy (SpigotMC, /dpm get medievaleconomy): a coinpurse and a physical currency item.
• PlayerLore (SpigotMC, /dpm get playerlore): players write their own lore onto their items.
• Medieval Cookery (no SpigotMC page, no stable release yet): cooking recipes for custom foods, defined by the server owner.
• Conquest Recipes (SpigotMC, /dpm get conquestrecipes): recipes for historical weapons, armour and shields named to match the Conquest resource pack.

Every plugin above is listed on dansplugins.com. Mailboxes is listed at dansplugins.com/resources/mailboxes and can be installed in game with Dan's Plugin Manager: /dpm get mailboxes.

Usage

• User Guide
• List of Commands
• Configuration
• Item Attachments

Support

You can find the support discord server here.

Experiencing a bug?

Please open a bug report here.

Roadmap

• Known Bugs
• Planned Features
• Planned Improvements

Contributing

• API Documentation for Plugin Developers
• Contributing Guide

Authors and acknowledgement

Name	Main Contributions
Daniel Stephenson	Creator

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

You are free to use, modify, and distribute this software, provided that:

• Source code is made available under the same license when distributed.
• Changes are documented and attributed.
• No additional restrictions are applied.

See the LICENSE file for the full text of the GPL-3.0 license.

Project Status

This project is in active development.

bStats

You can find the bStats page for this plugin here.

Usage reporting

Usage reporting is on by default: when the plugin is enabled, and each time one of its commands is used, it sends its name, version and the command name to the author's trace server so it is known which plugins are actually in use. Nothing about players, worlds or IPs is sent, and nothing typed after a command. The plugin says on the console at every start whether reporting is on. Each event also carries a random server ID (the server-id line in plugins/trace/config.yml) so servers can be counted rather than events. It identifies no person, account or IP address; delete the line to get a new one.

To turn it off:

• for this plugin: set usage-reporting.enabled to false in plugins/Mailboxes/config.yml;
• for every plugin on the server that reports to trace: set enabled to false in plugins/trace/config.yml (created on first start);
• for the whole server process: set the environment variable TRACE_USAGE_REPORTING=off or DO_NOT_TRACK=1.

Details: https://danielstephenson.dev/usage-reporting