Module: Mail - Module ID: mail

Introduction

The Mail module allows players to send private messages to each other through the use of an inbox. The messages are stored until the user chooses to clear them.

Sending and Receiving Mail

Mail can be sent to another player using the /mail send command,

/mail send <user> <message>

The receiving player will receive a notification that they have a mail ready for them. They can read it using (filters will be explained below)

/mail [filter]

The player can clear their mail using the command

/mail clear

Spying in Other’s Mailboxes

If there is a need to investigate someone else’s mail, the command is

/mail other <user> [filter]

Mail Filters

Mail Filters allow users to filter the mail that gets displayed. The following filters are available:

  • p:[player] - select mail from a certain player
  • m:[string] - select messages that contain this string
  • c: - select messages that are not from a player (e.g. console)
  • b:[days] - select messages sent before the specified number of days from today (so b:2 means messages sent more than two days ago)
  • a:[days] - select messages sent after the specified number of days from today (so a:2 means messages sent less than two days ago)

So, the filters p:dualspiral b:2 m:Nucleus will select messages sent by dualspiral more than 2 days ago that contain the string “Nucleus”.

/mail
Module: mail
Retrieves mail that has been sent to you.

Aliases: mail email

Root command aliases: /nmail

Usage: /mail [<filters>*]

Available subcommands: other, clear, send

Default Role: USER

Basic Command Permission: nucleus.mail.base

Permissions

  • nucleus.mail.base - Default Role: USER
    Allows the user to run the command /mail clear

This command is an equivalent to the following command(s) in Essentials: /mail, /email

/mail clear
Module: mail
Clears all mail in your inbox.

Aliases: mail clear

Usage: /mail clear

Default Role: USER

Basic Command Permission: nucleus.mail.base

Permissions

  • nucleus.mail.base - Default Role: USER
    Allows the user to run the command /mail clear
/mail other
Module: mail
Read others' mail.

Aliases: mail other mail o

Usage: /mail other <user> [<filters>*]

Default Role: ADMIN

Basic Command Permission: nucleus.mail.other.base

Permissions

  • nucleus.mail.other.base - Default Role: ADMIN
    Allows the user to run the command /mail other
/mail send
Module: mail
Sends a mail to the specified player.

Aliases: mail send mail s

Root command aliases: /sendmail

Usage: /mail send <user> <message…>

Default Role: USER

Basic Command Permission: nucleus.mail.send.base

Permissions

  • nucleus.mail.send.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /mail send
  • nucleus.mail.send.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /mail send
  • nucleus.mail.send.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /mail send
  • nucleus.mail.send.base - Default Role: USER
    Allows the user to run the command /mail send
Permission Suggested Role Description
nucleus.mail.base USER Allows the user to run the command /mail clear
nucleus.mail.other.base ADMIN Allows the user to run the command /mail other
nucleus.mail.send.base USER Allows the user to run the command /mail send
nucleus.mail.send.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /mail send
nucleus.mail.send.exempt.cost ADMIN Allows the user to bypass the cost for /mail send
nucleus.mail.send.exempt.warmup ADMIN Allows the user to bypass the warmup for /mail send
There is no configuration for this module.