Notice

We are currently rewriting the plugin from scratch to add database support, etc. The test version provided in the alpha branch may be unstable. Please be sure to make a backup before running it.

All documentation below is for the old version before the rewrite. This will be updated in the future.

MailBox

The mailbox implements a mail system like those found in smartphone games. You can customize the behavior when clicking on a mail, and you can attach reward items or execute commands.

Depencies

Paper 1.21.x Only

Commands

• /mailbox Open mailbox menu.
• /mailbox reload Reloads config and messages.
• /mailbox clear <target> Clear target's all mail.
• /sendmail <item_display> <name> <description> <action> (<target>|schedule <until>)
  • <item_display> example: stone[enchantments={levels:{infinity:0}}]
    Same as vanilla ItemStack argument. wiki
  • <name> example: "mail title" '{"text":"something"}'
    Same as vanilla Raw JSON Format wiki
  • <description> exmaple: ["","line1","line2"] Same as <name>, but only chlidren are shown.
  • <action> example: '{"action":"<action>","value":"<value>","used":false}'
    • <action> Type of action.
      • none: Do nothing.
      • close: Closes mailbox menu
      • reward_item Give a reward item to player.
      • run_command Run a command as player. (execute like this execute as <player> run <command>)
    • <value> Value for action.
      • When <action> is none or close ignore this <value>.
      • When <action> is item, <value> is same as vanilla ItemStack argument. wiki
      • When <action> is run_command, <value> is a command. (/ is not required.)
    • DO NOT CHANGE used field
      The plugin uses used field to check player already clicked the mail.
      If this field are set true, all players will receive the mail as clicked.
  • <target> Player. You can use target selector wiki
  • schedule <until> Sends an email to all players who are online by the specified time.
    • <until> Time to end sending email. ISO_DATE_TIME format yyyy-mm-ddThh:MM:ss

Configuration

_version: 3 // DONOT CHANGE
mail-schedules:
- enabled: true
  name: '"test mail"'
  description: '{"extra":["hello!","this is test mail!!"],"text":""}'
  start: '2024-08-09T17:38:45'
  end: '2024-08-09T19:00'
  item: minecraft:shulker_box
  action: '{"action":"reward_item","value":"diamond","used":false}'
- enabled: true
  name: '"login bonus"'
  description: '{"extra":["hello!","this is date exclusive login bonus!!"],"text":""}'
  start: '2024-08-09T00:00:00'
  end: '2024-08-09T23:59:59'
  item: minecraft:chest[enchantments={levels:{infinity:0},show_in_tooltip:false}]
  action: '{"action":"reward_item","value":"/give @s emerald 64","used":false}'
messages:
  mail-box: MailBox
  reload: Configuration reloaded
  received-time: Received
  sent-mails: 'Sent mail [name: <name>] [description: <description>] to <targets>'
  scheduled-mail: 'Scheduled mail [name: <name>] [description: <description>] at <time>'
  received-mail: <yellow>You have received a mail!
  open-mail-box: <click:run_command:/mailbox>Click here or type /mailbox to open your
    mailbox
  change-previous-page: Next page
  change-next-page: Previous page