io.github.nucleuspowered.nucleus.api.module.mail.event

Interface NucleusMailEvent

All Superinterfaces:

org.spongepowered.api.event.Cancellable, org.spongepowered.api.event.Event

@MightOccurAsync
public interface NucleusMailEvent
extends org.spongepowered.api.event.Event, org.spongepowered.api.event.Cancellable

An event that is posted when a player uses /mail in NucleusPlugin

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() The message that was sent.
org.spongepowered.api.entity.living.player.User	getRecipient() The recipient of the mail.
java.util.Optional<org.spongepowered.api.entity.living.player.User>	getSender() The sender of the mail.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getSender

java.util.Optional<org.spongepowered.api.entity.living.player.User> getSender()

The sender of the mail. If Optional.empty(), this means it was some server process.

Returns:

The sender

getRecipient

org.spongepowered.api.entity.living.player.User getRecipient()

The recipient of the mail.

Returns:

The recipient.

getMessage

java.lang.String getMessage()

The message that was sent.

Returns:

The message.