Configuration

The config file lives at plugins/AT-MailBox/config.yml. It is fully commented in game, so this page focuses on what each section controls and the settings you are most likely to change.

After editing, apply changes with /mailbox admin reload.

General

general:
  language: "english"
  debug: false
  update-check: true

See Messages and language for translations.

Database

database:
  type: "SQLITE"
  host: "localhost"
  port: '3306'
  name: "atmailbox"
  username: "root"
  password: ""
  table-prefix: "atmailbox_"

type can be SQLITE, MYSQL, MARIADB, or H2. The host, port, name, username, and password apply only to MYSQL and MARIADB. Full details on Storage.

Mailbox pages and capacity

mailbox:
  pages:
    slots-per-page: '45'
    max-pages:
      unlimited: '999'
      mvp: '6'
      vip: '4'
      default: '2'

• slots-per-page is how many item slots show per page. The maximum is 45, because the bottom row is reserved for controls.
• max-pages defines your capacity tiers. Each tier grants atmailbox.capacity.<name>. You can add, rename, or remove tiers. See Capacity tiers.

Expiry

mailbox:
  expiry:
    enabled: true
    days: '7'
    warn-before-days: '1'
    warn-on-join: true
    warn-periodic: true
    warn-period-minutes: '60'

Controls how long items live and how players are warned. See Item expiry.

Ground capture (master switch)

mailbox:
  capture-ground-drops: true

This is the master switch for catching anything that lands on the ground at a full player's feet: crate and vote rewards, /give overflow, and items handed over by other plugins. It must be true for the mailbox to catch handed-out items at all.

Triggers

mailbox:
  triggers:
    pickup: true
    commands: true
    plugin-rewards: true
    api: true

Chooses which sources may fill the mailbox. Turning one off makes those items behave as if AT-MailBox were not installed: they stay on the ground or are handled by the plugin that produced them, and nothing is deleted.

/mailbox admin deliver always reaches the mailbox regardless of these switches.

A common setup on servers with a paid backpack is pickup: false with the rest left on, so the mailbox only ever catches handed-out items and never competes with the backpack during normal play.

Stacking

mailbox:
  stack-similar-items: true

Merges identical items into one mailbox slot, up to a normal stack size, instead of using a new slot per delivery. Expiring and never-expiring items are kept in separate slots, and a merged slot always keeps the earlier of the two expiry times.

Full mailbox behaviour

mailbox:
  full-overflow:
    drop-at-feet: true

When the mailbox is also full, true drops the item at the player's feet and false rejects it with a message. See Overflow capture.

Login notify

mailbox:
  login-notify:
    enabled: true
    chat: true
    title: true
    sound: "ENTITY_EXPERIENCE_ORB_PICKUP"
    cooldown-seconds: '300'

The "you have mail" message on join. See Login notify.

GUI

gui:
  rows: '6'
  fill-empty: true
  filler-material: "GRAY_STAINED_GLASS_PANE"
  notify-button-material: "BELL"
  claim-all-count-mode: "both"
  sounds:
    open: "BLOCK_CHEST_OPEN"
    claim-one: "ENTITY_ITEM_PICKUP"
    claim-all: "ENTITY_PLAYER_LEVELUP"
    page-turn: "UI_BUTTON_CLICK"
    settings:
      open: "BLOCK_CHEST_OPEN"
      notify: "UI_BUTTON_CLICK"
      auto-existing: "UI_BUTTON_CLICK"
      auto-all: "UI_BUTTON_CLICK"
      refresh: "BLOCK_AMETHYST_BLOCK_CHIME"
      back: "UI_BUTTON_CLICK"

Controls the look and sound of the menu. rows is 3 or 6. If you set it to 3, keep slots-per-page at 18 or fewer. The menu title is set in the language file (gui.title), not here. claim-all-count-mode decides what the Claim All button counts: slots (occupied mailbox slots), items (total item amount), or both (default, reading as 116 slots used for 1050 items). The words around those numbers are translatable in the language file under gui.claim-all-button.count-slots, count-items and count-both. notify-button-material is the icon for the login-notification button in the settings menu. The sounds.settings block sets a separate sound for each button in the Mailbox Settings menu; leave one blank to silence it. See The mailbox GUI.

InfiniteBags

infinitebags:
  enabled: true
  defaults:
    auto-existing: false
    auto-all: false
  gui:
    settings-button-material: "COMPARATOR"
    auto-existing-material: "HOPPER"
    auto-all-material: "ENDER_CHEST"
    refresh-material: "CLOCK"
    back-material: "ARROW"

Lets players auto-send claimed items into their InfiniteBag from the Mailbox Settings menu. This section is ignored unless the InfiniteBags plugin is installed. See InfiniteBags integration.

Colors

Text settings in the language files (such as gui.title) support color codes:

• Legacy & codes like &a, &l, &c.
• Hex in the form &#rrggbb, for example &#44eebb. Hex needs a 1.16 or newer client.