zEssentials
Spigot
  • Getting Started
    • ๐ŸพIntroduction
    • ๐Ÿ”ŒInstalling zEssentials
    • ๐ŸชConvert
    • ๐Ÿ“”Commands
    • ๐ŸชงPlaceholders
    • ๐ŸŽซPermissions
    • ๐ŸŽจColor
    • ๐Ÿ“–Messages
    • โน๏ธInventories / Buttons
    • ๐Ÿ“‚Configuration
  • โ›ฐ๏ธModules
    • โŒจ๏ธAfk
    • ๐Ÿ—ฃ๏ธChat
    • Discord
    • ๐Ÿ’ฒEconomy
    • ๐Ÿ‘ปHologram
    • ๐ŸกHome
    • โš”๏ธItems
    • Join / Quit
    • ๐ŸŽฟKits
    • ๐Ÿ“ฌMailbox
    • Messages
    • ๐Ÿ“Rules
    • โš’๏ธSanction
    • ๐Ÿ’ฏScoreboard
    • ๐Ÿ”Spawn
    • ๐ŸšStep
    • Teleportation
    • Vault
    • ๐Ÿ—’๏ธVote
    • ๐ŸคœWarp
    • ๐Ÿช“Worldedit
  • Developpers
    • ๐Ÿ•ขEvents
Powered by GitBook
On this page
  • Configuration
  • Config.yml
  • Mailbox Inventory
  1. Modules

Mailbox

PreviousKitsNextMessages

Last updated 10 months ago

This module allows you to create a mailbox for your players' items. When the plugin gives an item to a player, it checks if there is space in their inventory. If not, the item is sent to their mailbox. The item will expire after a configurable number of days.

The plugin's API allows other plugins to add items to the mailbox. For example, an AuctionHouse plugin (such as ) can integrate with zEssentials to deliver items directly to the mailbox instead of using the plugin's pending inventory system.

Configuration

Config.yml

########################################################################################################################
#
# โ–ˆโ–ˆโ–ˆโ•—โ–‘โ–‘โ–‘โ–ˆโ–ˆโ–ˆโ•—โ–‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–‘โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•—โ–‘โ–‘โ–‘โ–‘โ–‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–‘โ–‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–‘โ–ˆโ–ˆโ•—โ–‘โ–‘โ–ˆโ–ˆโ•—
# โ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–‘โ–ˆโ–ˆโ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ•šโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•
# โ–ˆโ–ˆโ•”โ–ˆโ–ˆโ–ˆโ–ˆโ•”โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•ฆโ•โ–ˆโ–ˆโ•‘โ–‘โ–‘โ–ˆโ–ˆโ•‘โ–‘โ•šโ–ˆโ–ˆโ–ˆโ•”โ•โ–‘
# โ–ˆโ–ˆโ•‘โ•šโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘โ–‘โ–‘โ–ˆโ–ˆโ•‘โ–‘โ–ˆโ–ˆโ•”โ–ˆโ–ˆโ•—โ–‘
# โ–ˆโ–ˆโ•‘โ–‘โ•šโ•โ•โ–‘โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–‘โ–‘โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•ฆโ•โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•”โ•โ•šโ–ˆโ–ˆโ•—
# โ•šโ•โ•โ–‘โ–‘โ–‘โ–‘โ–‘โ•šโ•โ•โ•šโ•โ•โ–‘โ–‘โ•šโ•โ•โ•šโ•โ•โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ•โ•โ•โ•โ•โ–‘โ–‘โ•šโ•โ•โ•โ•โ•โ–‘โ•šโ•โ•โ–‘โ–‘โ•šโ•โ•
#
# Documentation: https://zessentials.groupez.dev/modules/mailbox
#
########################################################################################################################

enable: true

# The expiration time of items when added to the mailbox
# If the player does not recover his items with expiration they will be deleted permanently.
expiration: 86400

Mailbox Inventory

Inventory of the mailbox, the items will be displayed thanks to the button ZESSENTIALS_MAILBOX

name: "#3f3f3fแดแด€ษชสŸส™แดx"
size: 54
items:
  items:
    isPermanent: true
    type: ZESSENTIALS_MAILBOX
    item:
      lore:
        - ''
        - '#ffd353โ„น Informations#3f3f3f:'
        - '#3f3f3fโ€ข &7Expires in#3f3f3f: #4cd5ff%expiration%'
        - ''
        - '&fโžฅ &nLeft Click&r&7 to get the kit'
    slots:
      - 0-44
    else:
      slots:
        - 22
      item:
        material: BARRIER
        name: '&c&nNo Items Found'
  info:
    isPermanent: true
    slot: 49
    item:
      material: BELL
      name: '&fแดแด€ษชสŸส™แดx'
      lore:
        - ''
        - '#ffd353โ„น Informations#3f3f3f:'
        - '#3f3f3fโ€ข &7The mailbox allows you to store items'
        - '#3f3f3fโ€ข &7 so that you can recover them later'
        - ''

  previous:
    isPermanent: true
    type: PREVIOUS
    slot: 45
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjllYTFkODYyNDdmNGFmMzUxZWQxODY2YmNhNmEzMDQwYTA2YzY4MTc3Yzc4ZTQyMzE2YTEwOThlNjBmYjdkMyJ9fX0="
      name: "#92bed8แด˜ส€แด‡แด ษชแดแดœs แด˜แด€ษขแด‡"

  next:
    isPermanent: true
    type: NEXT
    slot: 53
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvODI3MWE0NzEwNDQ5NWUzNTdjM2U4ZTgwZjUxMWE5ZjEwMmIwNzAwY2E5Yjg4ZTg4Yjc5NWQzM2ZmMjAxMDVlYiJ9fX0="
      name: "#92bed8ษดแด‡xแด› แด˜แด€ษขแด‡"
โ›ฐ๏ธ
๐Ÿ“ฌ
zAuctionHouse